diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx index 18f048a2627..d1b5a802b54 100644 --- a/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism ### Publisher - + Represents a “publisher”. Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like: @@ -66,7 +66,7 @@ Message broker for the Publisher / Subscriber mechanism ### Subscriber - + Represents a “subscriber”. Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx index b3ba66410da..a6eebea4de3 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum device. You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx index 7eb07fcb85d..1ff3cf65a5f 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError # IBMBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx index 8bfaa8fe85b..3c71ae73da8 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError # IBMBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx index 89021759990..3ced87dc4c0 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError # IBMBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx index eb0235210e4..9eeccccffcb 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService # IBMBackendService - + Backend namespace for an IBM Quantum account. Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx index 4b16c0e42f3..39aba6fbec2 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError # IBMBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx index ecad48f2f39..9323d8b67f5 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError # IBMError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx index 370269522ca..4c1fb7e9c44 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider # IBMProvider - + Provides access to the IBM Quantum services available to an account. Authenticate against IBM Quantum for use from saved credentials or during session. @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### save\_account - + Save the account to disk for future use. **Parameters** @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx index a3f49c8115a..38a2c451ec0 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError # IBMProviderError - + Base class for errors raise by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx index 5b219c2c499..fe4a08b39ae 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError # IBMProviderValueError - + Value errors raised by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx index 6d7fc97f4d8..ab632916e1c 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx index e0aae404824..3971e73cb94 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob # IBMCircuitJob - + Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx index f16b85a7cac..2e41f735c79 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob # IBMCompositeJob - + Representation of a set of jobs that execute on an IBM Quantum backend. An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter. @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### from\_jobs - + Return an instance of this class. The input job ID is used to query for sub-job information from the server. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx index 2273fd4aec2..264512e49b8 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError # IBMJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx index 80b2644704d..cec2586d3a8 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError # IBMJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx index f7c5cb6fd4f..392576bdb84 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError # IBMJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx index 5897bf0d9c1..677d93072d3 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError # IBMJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx index bd1a19fa291..5c160eaf117 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError # IBMJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx index 7fca6c5abf8..3300446ac9c 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo # QueueInfo - + Queue information for a job. QueueInfo constructor. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index a01d5ec3cf0..63d90929258 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 23a211f242a..a95ae4d14bc 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx index 52f4cb1bb93..af7c7a22bc1 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 0af8eefceb8..ba90d32d7e5 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx index a2f38cd5bf4..af5c9fa2100 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index c0f1544ec65..172149cd843 100644 --- a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.mdx index 725e0c48ff4..33b16635809 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum device. You can run experiments on a backend using the [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.45)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -481,7 +481,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.mdx index e5c5adada97..a6a4bb5f0bb 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError # IBMBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx index 7c8e187533e..b3a43b83992 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError # IBMBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.mdx index b066945d4fd..8eee3c57e5c 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError # IBMBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.mdx index e6ba07d2185..a4f14a465b4 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService # IBMBackendService - + Backend namespace for an IBM Quantum account. Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.mdx index ee73a61b052..15db527dc98 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError # IBMBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.mdx index 82aafea3b86..7ee08287785 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError # IBMError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.mdx index 7a2c00a7798..42490c6da97 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider # IBMProvider - + Provides access to the IBM Quantum services available to an account. Authenticate against IBM Quantum for use from saved credentials or during session. @@ -200,7 +200,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### save\_account - + Save the account to disk for future use. **Parameters** @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.mdx index f117244d491..b01b3bd5a53 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError # IBMProviderError - + Base class for errors raise by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.mdx index ea225688b07..c3336b45285 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError # IBMProviderValueError - + Value errors raised by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.mdx index a5f16df466b..4d410afc683 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.mdx index eb08c13d172..ed5be81886d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob # IBMCircuitJob - + Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.mdx index eef9c2d9e7a..017a872f9ed 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob # IBMCompositeJob - + Representation of a set of jobs that execute on an IBM Quantum backend. An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter. @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### from\_jobs - + Return an instance of this class. The input job ID is used to query for sub-job information from the server. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.mdx index 7ce77f8f7e6..3bd05dc0b5f 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError # IBMJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.mdx index b265b7f0ae9..97541ede6e3 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError # IBMJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.mdx index 31c53964e72..472145484ed 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError # IBMJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx index 47bf52efda6..170ec5307ed 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError # IBMJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx index 85b099b7db6..995dfd55312 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError # IBMJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.mdx index 89dd742e0da..8cd8b74f3dd 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo # QueueInfo - + Queue information for a job. QueueInfo constructor. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 446c5ceb0fd..8efc1cf7c41 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index efcaa525687..55e9fecd3df 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx index f54846a5dda..85b5d8bbb8d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 9f0cbbcb608..6cb37cdbf6d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_backend - + Construct an `InstructionDurations` object from the backend. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx index d0b630c6654..3d25ebfa76f 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 92276271b0d..fe5632977af 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.mdx index 7a6b1ed954c..059648b3f39 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum device. You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.45)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.mdx index 3eb13b19312..9c448fff596 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError # IBMBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx index ecde16837b7..fcea761f3d4 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError # IBMBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.mdx index e877b9212a6..f74122e4157 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError # IBMBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.mdx index 7ef1d0baa4c..5e10911dbc0 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService # IBMBackendService - + Backend namespace for an IBM Quantum account. Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.mdx index bb7cb2766ea..78c4a133245 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError # IBMBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.mdx index f8914b1a6e2..2ea14bd53f6 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError # IBMError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.mdx index e2fe639d9a3..b62c5df74a2 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider # IBMProvider - + Provides access to the IBM Quantum services available to an account. Authenticate against IBM Quantum for use from saved credentials or during session. @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### save\_account - + Save the account to disk for future use. **Parameters** @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.mdx index c282c52e295..e9c9a9e640e 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError # IBMProviderError - + Base class for errors raise by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.mdx index 5f831086a15..65bc36068ef 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError # IBMProviderValueError - + Value errors raised by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.mdx index f36615f70ee..645940a3b96 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.mdx index b23eaa7d972..eb5290e64dc 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob # IBMCircuitJob - + Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.mdx index 063ce0ffeaa..28a584b1943 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob # IBMCompositeJob - + Representation of a set of jobs that execute on an IBM Quantum backend. An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter. @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### from\_jobs - + Return an instance of this class. The input job ID is used to query for sub-job information from the server. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.mdx index d135fd3f27a..4f587fbc966 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError # IBMJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.mdx index c8be7c44b86..217c3b49061 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError # IBMJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.mdx index b15625fce39..9c3bee9a0f8 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError # IBMJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx index df245d3557d..1d30c8d6d6b 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError # IBMJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx index 2bda6fe4308..0cd9165dccf 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError # IBMJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.mdx index 2a7ecd3a1f1..b89945f1bf4 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo # QueueInfo - + Queue information for a job. QueueInfo constructor. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 5fe7af7cd01..ec2e8cfe4a2 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 147e5466718..e2d4deacb9e 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx index 4dc98add5b1..384fd73f170 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 094d0b6cd26..e40d7923f81 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_backend - + Construct an `InstructionDurations` object from the backend. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx index 624623b90c7..de42e99ce17 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 27bcccc6e34..f116558a7b7 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_utils.mdx b/docs/api/qiskit-ibm-provider/0.9/ibm_utils.mdx index 50ca1bbd6de..917c9bb155e 100644 --- a/docs/api/qiskit-ibm-provider/0.9/ibm_utils.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/ibm_utils.mdx @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism ### Publisher - + Represents a “publisher”. Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like: @@ -66,7 +66,7 @@ Message broker for the Publisher / Subscriber mechanism ### Subscriber - + Represents a “subscriber”. Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.mdx index 115ff60f239..a37f150e063 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum device. You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.mdx index 6ce8a4896e6..acb92e2f2b8 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError # IBMBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx index 89b866a4789..b78e63519fb 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError # IBMBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.mdx index ba657cc246a..1d0906ae2fc 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError # IBMBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.mdx index 6fc9417f9bd..053c467baa1 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService # IBMBackendService - + Backend namespace for an IBM Quantum account. Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.mdx index bd3d21678ee..2c2ee2db5f2 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError # IBMBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.mdx index 526ca6ca913..5d4ac94a410 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError # IBMError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.mdx index d178cf23bce..2945cfcae22 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider # IBMProvider - + Provides access to the IBM Quantum services available to an account. Authenticate against IBM Quantum for use from saved credentials or during session. @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### save\_account - + Save the account to disk for future use. **Parameters** @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.mdx index 194d06ce0bc..6d01c048d1a 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError # IBMProviderError - + Base class for errors raise by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.mdx index 4d26a689832..67d065e611a 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError # IBMProviderValueError - + Value errors raised by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.mdx index 6f51e1a36d4..78b6d497fda 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.mdx index 691b530297c..3f457e1a37b 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob # IBMCircuitJob - + Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.mdx index ee9f0fcbb16..8452bcab490 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob # IBMCompositeJob - + Representation of a set of jobs that execute on an IBM Quantum backend. An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter. @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### from\_jobs - + Return an instance of this class. The input job ID is used to query for sub-job information from the server. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.mdx index c49410f2369..b277bcf7c62 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError # IBMJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.mdx index 1c9aabbd8cb..4ab983ee125 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError # IBMJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.mdx index 609c900e17e..1ff45feefb1 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError # IBMJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx index 0504c81440d..21bb8308171 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError # IBMJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx index cfdfd845219..69241363fd0 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError # IBMJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.mdx index 1a26bc119f1..32817358d9c 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo # QueueInfo - + Queue information for a job. QueueInfo constructor. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 8304cb5c53b..58bc64eeea1 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 5684751a782..437391a429a 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx index e6f687bf4af..095664383b7 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 374f104c5f7..c9e48ea98f9 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx index c59f158f921..e43507255c8 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index c644c87fe48..ab12254d338 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-provider/ibm_utils.mdx b/docs/api/qiskit-ibm-provider/ibm_utils.mdx index b6b4a7ee814..5fc4e62278b 100644 --- a/docs/api/qiskit-ibm-provider/ibm_utils.mdx +++ b/docs/api/qiskit-ibm-provider/ibm_utils.mdx @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism ### Publisher - + Represents a “publisher”. Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like: @@ -66,7 +66,7 @@ Message broker for the Publisher / Subscriber mechanism ### Subscriber - + Represents a “subscriber”. Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx index b6e72c798a8..e5f1edaa4ee 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum device. You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx index 2b5c6d6cc10..bb4080c9e30 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError # IBMBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx index bc729128122..2a5600c9d70 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError # IBMBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx index e8e693167b2..db99e15e2fa 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError # IBMBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx index 37d68961973..f1743a55807 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService # IBMBackendService - + Backend namespace for an IBM Quantum account. Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx index 63dd8fd6d12..9099249fc9d 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError # IBMBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx index 70513811641..057e8305153 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError # IBMError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx index f313c05afff..35aec19bf98 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider # IBMProvider - + Provides access to the IBM Quantum services available to an account. Authenticate against IBM Quantum for use from saved credentials or during session. @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### save\_account - + Save the account to disk for future use. **Parameters** @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx index a18457eff0b..c1c9d37c991 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError # IBMProviderError - + Base class for errors raise by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx index 22c7a3e122f..cc106006317 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError # IBMProviderValueError - + Value errors raised by IBMProvider. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx index 85111f73203..7bd36aaefa5 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx index 544356f5411..4dafc43a5b8 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob # IBMCircuitJob - + Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.mdx index 062847922e0..0a324c0362e 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob # IBMCompositeJob - + Representation of a set of jobs that execute on an IBM Quantum backend. An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter. @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### from\_jobs - + Return an instance of this class. The input job ID is used to query for sub-job information from the server. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.mdx index 4b2ec47d20a..ac128fc8f9d 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError # IBMJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.mdx index dbdd940c761..fad704418cd 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError # IBMJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.mdx index 12d87927001..d7cb738915b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError # IBMJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx index 35bbde163eb..6c430420a95 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError # IBMJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx index 2940085a2bc..6adaa130959 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError # IBMJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.mdx index a16417fc0ff..45d5be28ae8 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo # QueueInfo - + Queue information for a job. QueueInfo constructor. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 2d26ac0e938..c725eea964c 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 9c40cce48ae..21a3d70e883 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx index 7655e0967b2..1c8d31d61d4 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 696ce309632..dd4c4974827 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. **Parameters** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx index d8538266104..dc8303c8913 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index d6fe6f74ae8..64474af43f3 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx index 9b38b372f17..34a9a4e2dcb 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx index 3bff0f2b709..fe7b6a377f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx index d4c86874cd6..2ba91720f08 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace # ParameterNamespace - + A namespace for program parameters with validation. This class provides a namespace for program parameters with auto-completion and validation support. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 046a10fbdec..431ae5f3c99 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -507,7 +507,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -531,7 +531,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.mdx index 39e65abff52..02b17b06f44 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.mdx index c7391466fcb..519f2fdc9d9 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.mdx index b03db6359c1..677be9c84ad 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.mdx index 1c710b36f06..cdfbb9218ce 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.mdx index f1061a0f797..fe64f813b9b 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram # RuntimeProgram - + Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.mdx index ec8146aba65..0543447d44d 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.mdx index c81aa825d84..a484e9056c9 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 8bd5b8d69e4..99284447ace 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.mdx index fa878aceb82..acd64c73df2 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.mdx index 394741e8f6d..4efd47c8c2e 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 3db82a65cb8..12bb4030cdd 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.mdx index e3f7b3dd346..87cc9fa89a9 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.mdx index d8922ea017f..1db7bd8b4a4 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.mdx index 883a73fdf26..ba2f8a72e3e 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.mdx index 62b3592e935..76030b46384 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.mdx index 95d2d8fa767..32fd6de8c56 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace # ParameterNamespace - + A namespace for program parameters with validation. This class provides a namespace for program parameters with auto-completion and validation support. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.mdx index b3cae9953bd..77075e7dd9d 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -507,7 +507,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -531,7 +531,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.mdx index 717ca4bc294..477ac99b5d7 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.mdx index 2f2acaea412..c7452ea934a 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.mdx index 532f925acbc..c1799755521 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.mdx index 2b31d6e92e2..a39b23ff511 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.mdx index b104efc4af1..13b96d0b726 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram # RuntimeProgram - + Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.mdx index 6b9d190bedf..35813449448 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.mdx index 7cbc0d4eaac..7bef39ee6fc 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index e88e9ca383b..1541cc6eec3 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 0c2004afc7f..1dc847e0e91 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.mdx index 5faf71be6f6..c005c6fd0db 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 837d348d108..eb0c93af69c 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.mdx index ced236f26da..4e2ab80ebd4 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 3111782eeeb..dfa88325615 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.mdx index 876d3d13cf0..98f2bba783e 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.mdx index daa474e0c95..e37d5344c9c 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 9a4669f77d8..f2a12fd0bc7 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.mdx index e4489a95f42..3fff7452368 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.mdx index fb179e68100..7d25bd6c93f 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.mdx index 9b3e68d7f3f..ee47c7ab303 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.mdx index c925e7ec869..9939a64f5c0 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.mdx index cf6572044a8..357d6210d90 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.mdx index 65ea706cf23..ec07c563067 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 10b4990ed20..89b7b823547 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 8bdd4418bd5..34a5b4e62ba 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.mdx index 92acf0a923d..2e37861a2bf 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 41880814ac6..d23a35786ce 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.mdx index bda9db4585e..f3fd8cf829b 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.mdx index dcf53c4ddfe..ad2466d11fe 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.mdx index 455cb0acc6b..28b71812b1b 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.mdx index 754b0cc167e..7fc78803a0c 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 56c0b477adb..e9206c8af2d 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.mdx index 385b9357b4b..d357978aeb2 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.mdx index a2284a6f52a..55e26c2af7f 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.mdx index e19dcc06287..fb84688c90e 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.mdx index e568c10e1fe..95286b32250 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.mdx index e527d0f838a..19cfce242a0 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.mdx index 50b7343bd43..587c524c3e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 664d747b944..23938585d25 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 6cb0cd1f349..bed5e3c4a52 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.mdx index 5693ee744ef..4942abb4c5c 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.mdx index f9730567a56..f13f92d2dcf 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 2aa22c81f01..9151c0c132a 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 23987ec3514..1622084fbc0 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.mdx index 9fd9b963332..60f7200a468 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.mdx index e2663e541c2..29693c57a30 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 48c37bc7e00..981032b844f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -425,7 +425,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.mdx index 1cd7dd49504..a1b367c8f49 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.mdx index a47dee6642e..29d31ceedfe 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.mdx index 631ac27787b..048e696e8d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.mdx index 12dbce51d55..f784b4bd791 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.mdx index 5e4e0287bad..800874ea9b9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.mdx index 3a732512d07..230d5be7b41 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 17aa2bee971..a2279ec29dc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 9a8993af156..57b6649c3e1 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index e344ad7daa3..d61e7a39da9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 4636a5b6e0d..a914c0d03f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index 5d00b8904ba..5b0cf4be6b9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index e2a3367d160..9e0c147f663 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index cd3d5a589cc..3d5414f70f6 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index e1c8fcab7c7..283169d282b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index 6e260b60cad..a843a5bfeb6 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index af662280b8d..dcb0ff9e6b6 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 1491044365e..7908a6a328c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index c542cc9eb02..b753077357b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 2315e2011aa..f2bff4a201b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 6974f0423e2..40556e2351b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index a19645a411f..6134964b560 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index abc267ea6d9..1afe9259b31 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 16591637a44..b3c807e6c47 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 6c0f21ceeae..f3e822f1944 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index edae32f93a8..b8e98ae08c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index baa9d525ed3..2b6e9de0e8a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 098c84d812d..33e6578516b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index 878f8d68265..81259fe60e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index e428a5e76e6..77c0cf8b013 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 5aa889faa0e..045474e9107 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index c6efe31496e..d6252756792 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 2a692633d43..c30052a4e93 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 6d084a4bcec..bf70fbc6607 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index f6062691030..c8f39eda650 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 558bfcc336f..c51de035ca3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index e6f44e2ad0b..2482f5dcaec 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 3759abea6d2..8d90eaf72bb 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index dd06e9327f9..decca7f9ed0 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 15981b1d5ff..63803d4e1e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 9aae4d58398..6cd85c1d7dc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index b9f82fb86ab..00b024835a7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 719ed688cb8..b9609dfc621 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index b561b6858b7..cf2a578deb7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index c03a758923b..f32cab150ac 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 80f68f44646..62921674851 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 87197d9ad69..c8f7035ccce 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index a747c517087..37b4d8bdadf 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index b9a6f6808ac..d2421220738 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index a388ca51f81..e88721f8b87 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index a38eac2430e..c82b25f27bd 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index 67814f589d8..0deb3776e3a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 25a1b6d9d3a..267ba20d0eb 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index b33071ddbb7..8eeab8011bc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 7ba5e9dfee7..a6d0177f137 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index a63b13a07e1..e6e4b129bcf 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index e55fd9dad51..00fe0f116b3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index 68eec6fe41b..174d05a2176 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 1f66eede144..8024a8710b7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index ed9d97e9758..914b4626cd9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index d0225030e6d..4c8cc38a8a8 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 1cd1f60a6b1..aece8954bf9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 224dd47dfa7..5dd4dd37a1f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index f7d12b5c067..d5ee502950f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index f339e7597d5..1839371601e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index 9966e91cedd..00930d5bfba 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 30506554e19..0aef9b255a5 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 36576fb69a4..f6e5fed2cc9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index c15120213fc..2adbbfd712d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 9d6e7656628..6fe866fc77b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index f4dba700567..5c3720b5442 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index 38814f20bba..a4cc96d8a88 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index bbb83476a0d..3070aa061f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 28ff8fa0c47..c9454892efd 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index 5e7cffdcd3e..2c6800d48a9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index a43d479561c..a7edfa71870 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 6b86ce84ea8..c927ba18466 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 102fd7ae148..7bd07203ec0 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 1b463ddbcb5..197e059022e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index 4c34582dbcd..772c192af22 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 600ddf29b86..fd3da624480 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index a5586e08867..e1f5b1a6205 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index caf512c7800..cf24752a1ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index fb16d54215a..eb8acf7deb5 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index b3796f33afd..a1691aa30c2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index 3057157f43b..87508b7ccd2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 819dc893d3a..b86fbcc6a4b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index f0b557193af..ae71c09d0ee 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index 83b65ecad09..b0bca45e2f8 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 713d688831b..ffb24521769 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index eed63becd17..9f015a8ad60 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 01150186417..088f1015a14 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index 6162f1c92f4..e12f4d439f8 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 5d71fbd23e5..a0e8c5c7a67 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index b675e0f6c94..f8b0d53b2d5 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 98dadda4e15..ba5f64defe1 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 64c3f001105..70af238a2e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index fb724104806..ed90b1a368d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index c0418351896..51062192e3b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 6841ade4a43..bdcea492c9a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.mdx index 6b8c307992d..4e401972676 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 15fe02209cd..7ba03e64d6a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.mdx index e8164aa7b8c..696d6e983d1 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 78676795a72..0994ac3ae77 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 3067ef60b89..fce03cc0ddc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 19c0525e4cf..84bd27aa87e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index c85f0121483..9676e2330a3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 43c0afb2c97..2c7f05d2e2f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct an `InstructionDurations` object from the backend. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 2d8f197fe32..bc3d64a8ae7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 74604838199..1a21e95cbb9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.mdx index c1a619d2ca8..5d239ea305e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.mdx index 6681125241c..c1ffb1edb0a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 53eddd15c86..7280e839f92 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -226,7 +226,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -432,7 +432,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -456,7 +456,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.mdx index 938760693cf..79f81602ea0 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.mdx index ee9b0d02682..4e54dd576f5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.mdx index 6081ab9367e..9ffd9c8a1eb 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.mdx index 235f23b9b56..fb6c22bb31a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.mdx index b9c56568ae6..00c1d9c5b9f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.mdx index 2ac609112a6..be7ea243b38 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -132,7 +132,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index d29ccde402e..f351a32dc8e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index c3d1948444f..ad8886e1673 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index e1a93281027..9fec9ea10ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 9fbfcc88fc3..6b7a58897fd 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index a5cb3b76a44..ea8e410760f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index 0a607e6f90f..210e1e417db 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 6b339bb7de3..5c549ea917a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 9a310e5a230..8773a4946ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index 657aa309815..2424283fa50 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 064d7ec00cd..58772a1880d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 222f4e58e1a..05f39a4732a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 7d425176286..6743817c2f2 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index a1f3008ced4..25824f92749 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 0898a7c88a9..e5d528b061e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 6bd2951e2ce..242ee3824a7 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index 91828199e19..936da2e50fe 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 123726dba0b..b41623dfd48 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 74ca6bc3421..ba1c51e256a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 8b2c648849c..4ccd29500f9 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index ec8494965b7..bed3ac45218 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index a39fee4712f..5bd939da8c0 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index 43ccfb85b0e..a768cb561c6 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index 11e862b3c4a..2c402b82104 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index cc249271e9c..720d3d448b5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index aef961f6eae..edad6a3e325 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index ec996cbc659..aac18ca71b3 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 998fe728335..c4ea266a2ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index aa709034ac3..3a81305df40 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 2eb5abff2ea..91c702136eb 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index df798aa10f0..1aa42d2e701 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 033c3007636..f016c79236f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 78ae0578dba..b5a13c62dce 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index b2bef2a3ab6..1e5fee27d25 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index d6c4208f91f..0f014f9a2a6 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index ee604839f93..bc463cb72d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 53b97d88af5..3e059bfab76 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index f31f2987b1d..207bfe3a7ac 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 5d860832271..accb1348420 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 073145bfc9f..363f7aad536 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 15d9b9d1991..1fb5f1595f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index ddfd4028999..3b2aabee801 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 0026ef805ac..35d5fa21299 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index 4540a04e2c5..1e0b29451be 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 2c7ca7dac47..36b0c36f40f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index 3d127d130c5..45504f95700 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 81920c49c30..3a4dd0ed956 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 1097f09818d..18d8d350b20 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index e08d153522b..1b3572ad916 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 40b84534815..46444297dd2 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 59831618be6..493ecad69ed 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index 9baf1db919d..daf2d90b894 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 63e426b2248..21bca4ba6db 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 8e0b9d41700..fdfcd2d8fe0 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index 7e0144209b5..8bc44869234 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 82c308d9517..8129fd2e992 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 2fde6288e44..46e78276952 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index 66439b9f8b8..7557a924436 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index 601a8e399cd..ab2d78e5854 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index b8805dc11e0..89a60097555 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 1224b4f58ce..95bff1665a5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 28a26af8cf6..b3ed4e6b677 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index f276a08247a..28cd82cbd8c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 11b63bf31ec..7c30aa40ed3 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 93fbb4eccf7..48694b82b57 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index c62c23f9a47..ce0f74b3350 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index 8c7fbefdf80..2fcec0ca590 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index c5aaaf859b2..e610746392a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index 3821bcb8501..f2c55d5f990 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index 1d57deefad6..78604d76d38 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index eb06f505fa1..f692b928a51 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 6818964da05..ab0aac70b2c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 9b6f4716f19..454c1e575fb 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index 9bd1a44e11a..c92d2b039d2 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 338e26112c7..8f5d1ec6258 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 4161e6dbb53..e523628af9f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index b11e3500785..a5ff979c058 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 15634a1355d..3d1db81658b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index 69664fe7af8..60bafb360d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index c734640eefe..7b6fceb7c38 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 0df2eb2ebad..d55d774989a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index 388d4416d6d..d21842bcd21 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index 158d792c70c..be68c7f0181 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 7bf599e29b5..a03c36b9a12 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index 4f7fae58cbe..47c68854b73 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 61596add3a2..83731d02744 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index 1b825699cda..a51c39889e7 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index e48555906de..cec8f635915 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index a9e52cb76c6..2c3e3bca009 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 67bea1ac5f4..4b6814a49bf 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 4da00aeed40..dcc1c92c97c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index e7cc366ca15..737718dcdc3 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 0587e6372aa..b7ee969457d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 3f70a6bd6d9..b05aea4258c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.mdx index 792e7e94002..402e29634fa 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 3f48e9c28b7..a7d1f7c8fc2 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.mdx index ee70bbd3ba6..a893009a4af 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 80b3d426ca8..4ff2520c1bc 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 7ee982f2aae..a8d20874b98 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index bace64e3922..b83ed4e96ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index e476eaf59dc..48eee2430bf 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 2868ff37b08..48af5c93589 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 1a782f2f421..e956feb3c3c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 43bd60b1339..c2fa167df2a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.mdx index a6d51f79f9a..4cc85a8e8c0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.mdx index 7e253bf15ed..9e8884d92bb 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 71409a3a775..785f729e210 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. @@ -226,7 +226,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -432,7 +432,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -456,7 +456,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.mdx index de925ecd283..5e071974953 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.mdx index b9fb632295a..d89868454d6 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.mdx index f8f3f9da645..f122223acf2 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.mdx index 9510e018af7..f6663ecae41 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.mdx index 7f1a547694b..6bf72a23928 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.mdx index 459401c889a..e4ef1b780ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a flexible Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. @@ -132,7 +132,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 8f1d4470fe6..9ab3ba1b41a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 5228cff2c9b..180956b415f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index 089e905c36d..9917ae4d811 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 2351e9d8141..c30cb02613a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index 3812312f390..67d3cdb656e 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index 6545aa78681..5f82793dbc2 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 1e4f07b5b1a..cf19a36736a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index f2113c121f7..8d44d3e06ac 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index 8549cc1150f..2afa363398b 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 0ce190f4ad8..8170649628b 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 0d6b6719814..20c6ebdd1ca 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 74cd3c0f4ac..4c8acb3478c 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 375f944fc06..240509b758e 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 8b45248cae8..20e713e802c 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index bfb717baee5..006fdb27c27 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index 3638c2507c2..7f5c49fabd0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index ddd8ee480de..f44a7520277 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 73b24d39807..9ab225e225f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index ad324e1cd2e..696a422dd4d 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 3252cd45b48..273dac0d7b0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 64bc4a651ec..5de087ce5f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index e90228bb96f..dbbe0ee10d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index 53c51cb27c2..f4a7c7267d3 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 7bcf85c1f41..8edbfd66ab8 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index 0712c019571..d4c1ac59b31 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index dca373c1d81..2cb6304c6a8 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index a8ddb84d5c8..06d56ecccd7 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index feea7ef24f0..829a7c55d43 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 0a1df5ce973..1eff21e1f5b 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index d85348551c2..a15fc970d34 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 5b1079055c5..fa5b9e25f15 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 7818294f2f0..55932844ecb 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 29ecf4e1ab4..2225a7224ee 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 1a9664133b2..9aa64caabac 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index 4db591e2a18..3b5028824ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index d5eb4068060..5b0366c885c 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index 4f38e1308a1..dcaaf67aa34 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 424d3b227a8..5bdb36ca9f3 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index d17c622feb6..dfac68e415f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 8c32f01de14..a5d167098e6 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 4ac837cad0a..1f70b1072d5 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 3d1f8f11cba..796f851a475 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index d64e0b433a9..5c90f197789 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 11370b0f393..f9933b6a05f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index e2935db3f2d..67cab8f9ef1 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 8a902417155..7f9bc1959bb 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 0e99d7356bd..d0d9d4c2fa5 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 06c54111b43..6cebd92ca38 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 35b35bab8ec..f05ce5aa9f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 5571fe053f9..ebe05be994f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index c46cfd1ed09..afece233351 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 4b3c90bc5ff..830b5c46e1c 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index d993cc3453c..92d776b0eb7 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index 39cafbbfd7d..2c98d981d60 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index b543853613f..3967acb5bbf 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 57ff3762117..21c9de65a10 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index 95bddb6d9e4..f42ca369390 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index 6f0e1fe33d8..0f7a36bb7b3 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index cf8024ee329..0f8fe8ff0a4 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 1750ccefd0d..42f433f4750 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 17225222fac..4437e3d6695 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index 780706b274d..7db668947a1 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index b919b9ea3f0..01650ab728b 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 5d5265503a5..3cac1da3251 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index da78b619be1..3e6b1b239c3 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index d8217eab0dc..c6053b2067f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 5a4ab3088b0..97337862b71 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index cdbd62b08d3..f8da196a9a4 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index 1d14712422d..d1ecf99c14f 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 8901ef19158..3c82fd9c424 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index fb87403284b..54ce424c45c 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index af6eac7919c..38971f2cdbd 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index c20e62773b4..c5339616a90 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 1334e2739bb..35f0eac2cf0 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 5d881de6b4e..f974f8c9f09 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index 3e18dbc3ae0..a3b38d1e5ab 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 493bf9fc75a..ce9ca8fc711 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index ae10199c187..0542d4b7246 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index dae0a769644..8db27acaae7 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 580089e1dc7..5a4f7847afe 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index c5ca5185f70..bddddcc2b11 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index c94208442cd..7d7c976509a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 506f9d73286..a63ad65ab5a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index c9f63b1af27..cd0cdcb6a3a 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index eac91f45adc..661ea23e195 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index 7b927da6ad2..74ab9be123b 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 1d301cce602..f8bb434afe8 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index f6b10ff761c..4ac21f97668 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 2a8be8929e3..01c7b333487 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 92c1792be78..3d14d1931d1 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 4fd2b1db376..06315a226d7 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index db3e871945a..0daaf3e84da 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions ### validate\_environment\_options - + Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.mdx index fee914e1cde..42fd7663588 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions ### validate\_execution\_options - + Validate that execution options are legal. :raises ValueError: if any execution option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.mdx index 5ec5d65366d..05080a57197 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 6f029e798e3..1722a0f0846 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions ### validate\_resilience\_options - + Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 4cb79a293e5..1aae1421b97 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -60,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### validate\_simulator\_options - + Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.mdx index d9ce4b16a25..5f8b87054e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions ### validate\_transpilation\_options - + Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 87eaf496e42..93d7aa1614d 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 3894536ad0a..fd9c918ccbf 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index f0f4c2981fc..66ff013972d 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 480388e769b..fcedd2d74df 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 27b9004aac0..04539f18525 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index a6d9f2257eb..a779ffe74af 100644 --- a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV1.mdx index eae6481f5ad..66c8cc3515a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV2.mdx index 40c0d78e1ed..c57a573175b 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.IBMBackend.mdx index 26e7fade830..9111468ff01 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 3ce4b816e76..40566817d6c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -177,7 +177,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -383,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -407,7 +407,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeDecoder.mdx index adffa4d68c4..e40f638c405 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeEncoder.mdx index 35e061ba9d5..957dcee0d9b 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJob.mdx index e62b6473f8c..a9d2f3d5c77 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJobV2.mdx index 50dc5dda76d..334c607aeff 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeOptions.mdx index a55bdb0894c..ef43be69c4f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV1.mdx index e35b4e7f5e2..82b55728d07 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV2.mdx index 7b9dd3d9f40..e412fc62598 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + Class for interacting with Qiskit Runtime Sampler primitive service. This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.Session.mdx index 279d90a84cc..3b707257cad 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. @@ -138,7 +138,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index fa4b2469b44..391e2182814 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index f139b4692c8..c6f26f260bf 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 03fb86618b5..81af1507a61 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index aa5fad2fabb..90598976dd5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 8cc601d0d92..db4460c3b52 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index acb2e6e3648..e77c9ccacf5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index 4abe0b1622d..12afd5a58e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 61d7693414e..424c01a67ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 50fcb40fa95..42bb02ffb34 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index f73a79b2de3..a0e36c7cdd1 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 5613c70185d..2d88d7c5521 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 17134de6c49..b84e71915ba 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 6a8fe5ca829..08eb65ce63c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 60f6a2f10f4..3043b82e22c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index c8d8cd61ad7..5c02431e3b4 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index f4334e83f07..83f9f54c0e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 3f697d993a9..8ceb39e59c6 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index 76fe2301968..1adf6242598 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index b3b50cbd148..f4e100df9ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index dd1a2538d83..0c5904af7fa 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index bba1b005a65..fe3e9e8e876 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 067e3c09821..0e8c3c854f9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index e37ce8c34ba..80fd863d742 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index 2502883f9d1..6cdd83e552f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index ac2876a7719..8ceeb949f13 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index aa6275fbcc4..a261ce4a3d2 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index db316cc5697..260a82c8b12 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index c8dde4574d4..437c96694b9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 351c1ceca33..60b835ba7eb 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index ebdd24a6390..7380f03224c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index dec57d40348..c7cc131dcf9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 6e9df9eaa8e..df6f3d68623 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index 31ab99f9cf1..d36e927adee 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index d9ccbc19e33..61a36197ac5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 5a87452d2ca..fac99fa8a8f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 9abe666dc15..ac30f3c77f1 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index e5440e6cd5a..4e941b8cb7f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 7f87896ef11..72e12fa77ba 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index af3db7e09ee..b9adde64565 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index b04a65f876b..819ecdd67ab 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index 8d5901d9eb4..6d53057d00f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index 8e4c102aa1f..8b7cb6d3769 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index f00c3f3108c..a03329c25d5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index d4111067e01..2fdf96964f9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index f1099208894..ecb7d013892 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 0f78d558dde..b8de1dd7d27 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 5bfd0ddb848..96351b577dc 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 1d9454ef81c..144ca99f865 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index 011ddb240d2..f674c1dcc19 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 85b94eef4ab..7b1f453701a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index acc3f826fce..0ce31e6b254 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 368f41834cd..90cee395e6e 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index cc207754281..8570b96947a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 0ccfa19b139..0270a808bd6 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 2c1d011654d..1203dadf92a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 3ca82505e8e..66ea32c5130 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index 88c1649162c..d6cabc7b5c3 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index c6f41682c5e..d26497ee562 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 14ed75901d3..5e641b8ec88 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index c88b65db3a6..522f3620eb3 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index 24410b791c8..1059b38e4f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index e926f213c42..e2ac55fa21f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 7d0c09d53bd..e40c04cc829 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index d51f817b027..9481f154f52 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index add12ea1bae..deefc617611 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index 2b171c9d903..e2df31ac865 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 1e00a29c10c..eed45a9a7d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 7ea966f00fb..d4cc385f880 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 38e1c37b4df..68d083c4e8c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index 6d73efc79e3..8db1e3fa9fe 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index be86fcc48b7..0732bc78597 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 2acdb85acff..baf81af5a38 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index bf32a767531..102dd98390a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 545b5152990..cdbaeb63a0c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index d88909c54b8..6f5756a0716 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 8ee33709e17..504f220197c 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index 84e7be158c4..e4d4286ee47 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index a0d9883354e..3f713fff1e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 060a734c69f..f43da6d7f43 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index c169d2a37c9..5b9bc5d8eb0 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index ae466b6c553..5062897a07e 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index b4b626137a9..35b802f4dbe 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 97ac0b7b47e..94ffcfabb2f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 473d2dbd112..7f4e4942354 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index a4e5b6052ee..8b926d18da4 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 79f085d7ae5..6e3df3eb0d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index 1994ce30f92..46895f5bfdd 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index bba77a646ec..f4cf6f5ab50 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 4e3a4dd8875..f5411962b34 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index a2794f5870a..45f5fe31057 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index 1335f08c03d..c275bca27c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index 0ddcdf65e7a..470550d859f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 951fe0843d1..14136a7b972 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index 32a5e16b5a3..ef8c78cb1d7 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 4ea7380a76c..3487a844e2f 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index 25ac004e699..ca9cc6273be 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index dabd9b27595..101c7b4f0b9 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index 0fab266b6bc..9907f4ec1c7 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 906b98b4e58..b9cf9d6b310 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 727fec1493b..0fbb0192652 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index e83872e44a1..300c27cc2d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index 331c4f3ea56..b1518b9d9f5 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 90a43db5c8d..d2d5b57f919 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 3405df2e8f4..cf9bbbec889 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptions.mdx index ad525ebc3fb..432e0fb9ff6 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx index ca095d84d93..2f3e655df45 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index 682da303b93..352180217ad 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index 8c828c8c250..a390d65fbea 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.Options.mdx index 949cbfb6df2..69b44359409 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.PecOptions.mdx index 419fd9c458b..8b54e2d418a 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 92487437a8e..ff41a1a7e44 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index 16402f3fa70..bc310024fa1 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SamplerOptions.mdx index d5b64fc9765..be8fb89dbdf 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 1ca3cb51078..51558ece5af 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 8f000cb9cb2..677f3484c07 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TwirlingOptions.mdx index 5cd42de93de..0e305b789dc 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ZneOptions.mdx index 9849c82b27c..da9501340ca 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 532d0e3e455..14e9ad4ed12 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 516f9e56c22..52e16307403 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index 5a5bc338ded..e68246553d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 6cfd47222c3..8da8513f039 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 7fd6c96eb46..2cd7c4dfc60 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index ae8ae349bec..94a7d72f0d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx index 151bb1f1a6d..95f7edf76af 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx index bd694ccfe57..7791e666f7d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx index 87d92d88823..3824d34e1f8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 3f69b911948..de60f15ddc5 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -167,7 +167,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -397,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx index 67dbbc217fd..aa02be072e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder.mdx index e612b410e40..e8b6d072dbb 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx index 8f403c1bd6d..e425eddb8ac 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx index 0d19ea9bdd3..38632096ed6 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx index e1b0411ca97..84a1dcf607d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx index 5d7a8d92e67..448b6765fc6 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx index 3eec9622380..f959d3c48bb 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + Class for interacting with Qiskit Runtime Sampler primitive service. This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx index 5cbcb61eae3..11eaadf95dd 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. @@ -138,7 +138,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index b25472f0311..42e4beea8e0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 534b1c94a4e..6c37776ef84 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 9aee5305bf6..5ed10067815 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index ff805e23ab6..48274075d9d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index ee07908d0c3..0598bb736a0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index 848927a36a5..44b85ea6f1a 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index bf96abb69d2..3d72c316153 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index ac6eba21f6e..06fa7dd7f92 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 07a7ccf413c..5f6eeda4838 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index a54e64285ee..9e656c34ae6 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index f4c224daf9f..f892ef5d553 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 28abf41a524..f06d13a719f 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 20995cd9c30..83db5cefc15 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 0ceddf4bfec..c02cc65fa7d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index a29e735c079..a7bcc2366c0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index ed3e153da15..e284e7d9d8d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 04affe7c9a5..2bec28156eb 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index cb1b83e64be..2840cba76c1 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 3c122a9d22d..fa75dee0092 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 1dc34408847..be4ca99530d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 62857456a6a..30e840521a0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 226d39723df..47bf7c0aa45 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 06b4ffae908..eb9ae346e19 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index b8d05149f64..79afec1b14e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index 78162edeae7..5c0d9d294c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 894d3d11b9b..c29055b1ccd 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 0d0fa1828ac..ead38b11e12 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index e846e7cf569..b0edeb2d6f1 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 2f119d9afe8..ec171f02f0e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 32369890f4a..8f21e5c9b96 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index 09e18a4527c..eb3daa142dc 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 0a282255fb2..76811ba97ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index 43be5266327..14b9d4ea60b 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 765fec44329..db948326146 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 30b79d5f4b5..4a65a7f2ad4 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 2fa9cda81ca..b4257375f4e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 75c3972d167..93bfb4df0f9 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 12b319ea012..7fd90971869 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index 77c1e32c4dd..0200597e1f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 7fe4fe477b3..efd4fec3fc3 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index bdb498bdb83..4390c256c7a 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index f9381b4769a..ffee801b16c 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index fc36348bd51..d1b80de4f91 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 50f5490229a..e617ea82bfa 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 24bf9efcc3f..f140aeae043 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 3a6c53dc7d6..e7f283f5647 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index bd10c7855cc..3ff008c59e3 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index c589bd78eb6..10622b29de8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index 29c9a1fc055..b236689b318 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index e7bfae9ad3e..0094413f77d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index d10335ce86f..2eecf6ac127 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index a8cabb85801..439f68bd22a 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 3d1f85e9eb3..f2d84e7635b 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index a0c4bcff935..d9f2169aa82 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index f1e366ceee7..a435bc0e940 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 336c3530250..7d5842411c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index aefc678fe23..d0ac486676e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index de6c0e53900..12f31eb3905 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 617ec2631aa..8a12a2222d3 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index 93b6c7a37f1..35367333380 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index f27b2468864..5d8bc0464bb 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 9448a529543..a98b037e6ba 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 106891c23d2..9ab37d55808 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index fe278c50c2b..85bf617c2a8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index f28571d1b8f..f510c799f3e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index dc344f6fcf7..09dbefa2e24 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 67db3b2a111..d70fa39ac34 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index dddf15245b4..0b089bd6740 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 0a9fd024a17..19695a45ca9 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index 11fc840120b..3c28153bac8 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index e58f3f4fb6f..05c9a85728d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 79d5851ebdf..367b218387f 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index ba75a73fb9e..710bd9cb6e0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 724cd549d46..04aabcddd20 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index 74f2212664c..f8d778e11d9 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 2a27c2bedc9..f9691262460 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index 41343785954..ba4f9ea1347 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index ca3f917dc29..6c02281ad46 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 987341e6a80..c69a44de0f2 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 0df4a4cd4ff..4f1436e77bc 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 7e8df740edb..448c16101c1 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index 83dc645d4fb..dcb5139d7aa 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 7d414b655e4..6371a1dcea2 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index f0f5f7616d9..32f19081584 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index 498e063f088..a6385ca86c7 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index ff5941a272c..b33856d41cf 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index e12d79860ca..ee561f846f5 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index c3653764b01..8889cb8a965 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 61f791bf94f..19e6af95920 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index fcf3c8a24cd..68085036662 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index 4046102f7a5..393d28dfeae 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index 75fa15cb486..de72235cd12 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index b69b3bbc4bc..0c3a978a547 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index 0a49606a869..8217edee78d 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 2ad4bfc9b14..54a94f86d48 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index ef83de10cde..d0d9dedf55b 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 460be0bdc57..dae1994ddc0 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index c3977bf1b04..95159ad5fa5 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index c6f05d22a27..56ebcbecd5e 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 56e417cc25d..a64a87ae5c4 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 313a5dc0d85..40c56717f97 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index c8ab04042ca..361fbd89739 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 46a062e91f2..5e20691d083 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx index f1cadc1ef92..101c41d3f19 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 69f604f6b44..a24f3549318 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx index b164a803352..5acb5cc19aa 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index 85f9e510be5..51cddad2b51 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index ae0bb0eef38..d7572845511 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx index 5670bae4202..27be30c47c1 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx index 3012aa15597..322c5f96416 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx index b247c3dc44c..f7aad135bc6 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index e3b994eb130..f0ba0ed4e90 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx index e35506268fc..07d8046aca3 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 6ab6ffa8801..a95dccfc076 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx index e94bd28d82a..51ce371a48f 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx index a0d6f4b1f8c..290436d04ce 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx index 1f71c73813b..aa7e0bc5087 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index b719088c568..9850850370c 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 804882c0889..09191c04131 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index 9b23055ca4e..e2195bbfe69 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 9d20c8898db..e2c729c21b9 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 2275981baef..6e1428a2076 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 219052caf6f..5a38baab9de 100644 --- a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx index f371a8a0aee..81ade2f5911 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Batch # Batch - + Class for running jobs in batch execution mode. Similar to a `session`, a Qiskit Runtime `batch` groups a collection of iterative calls to the quantum computer. Batch mode can shorten processing time if all jobs can be provided at the outset. To submit iterative jobs, use sessions instead. @@ -158,7 +158,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx index 14e6098590e..fda9c59afaa 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx index f0dee473b8f..7970ffc67d0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx index 2b0ac7f848a..86c340025d1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx index ddffa9dfafa..d018ec92e11 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -167,7 +167,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -397,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx index 93fbb424e74..8464f851cce 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx index 7924b5c801c..1ac1fce5b5b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx index 9aba970d4aa..6fe8efab97d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx index f8e12f91200..6af1c1000d6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.mdx index 732ffcb7ba2..a6031055327 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx index ba6b697c27b..3e1dbe337b1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx index e862f96e435..5d117190f5c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + Class for interacting with Qiskit Runtime Sampler primitive service. This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx index d80e5e511fc..ae8596761dd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. @@ -153,7 +153,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index bcd7b6d472f..395a9ba27fb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 84216240830..982fd5ac91e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 8ad8eedd280..b43340a1b68 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index 512230b1ce8..2c8fedc00f9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 16cec8faec9..90fb47f366a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index ae8d1feffff..617f556c07c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index e469430d67e..6bb53cddcb2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 64b3aced3dd..3d70e4ae146 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index ceac918324f..abcd144f33f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index e8cc0908bc5..e3f517e01da 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 134d34bee4c..85b3ad30993 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 80a7296a411..494cf8bccd3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 5faafc0f512..b5338c71357 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index bd06c3f8993..7766df715a0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index d8058b31053..dbc6173570e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 7501d36a780..45b3f219b4a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 47d56b2503a..4fc3fbcf394 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index 2dfa041cfc9..6e83aa3cc66 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 94f56cd5c14..5795a4c21e3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index b817b1bcb19..63961bb0ad3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 556a0d77310..7f23f765441 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index d76a758996a..c660d40bc02 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 0b6036ea98f..ff4c0770de6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index 1a969b449bf..0cc32430221 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index 3bf60ea9abf..6cc0ce9fce3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 1546f8e4036..23f7a69aebf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 2edc235b6ad..1764b138a6b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index 639acd3c5fc..0d1f54ec0df 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 807d163c34a..37f0758292e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 0c0f54db5d0..60a310d45fe 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index d9e85918da9..6cb2a038ae7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index bd4f2f06fe8..56a36f82034 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index b3f7bfb9c41..83c72077692 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 32e4bc2942d..db0e1c227ec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 00224ae18c7..28506ce56a5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index a2e610b1b25..a0877afbaff 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index a9e2e80e571..100dccd0d3b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index ba6c000809c..5d15ed2092f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index 27236fa3d7d..2c57eea7f5a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 68f50c4a539..d1b8c4e8c68 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index ab3933584d3..ea6f656019e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index 31c811f6381..5055d9cb613 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index 35b4a35d861..d9486fe257d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index e19ae06a26d..212e24ae935 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 2d42a9659a6..e7d5a4a9231 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index e45df50c612..0f4cbdd7c8c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 278d7fc3a90..46f27073c5b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 6408d633e6c..916faaa247e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index 30cb2e59c26..ad6a8ba2c53 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 25e5b8ad1b2..d41e1c7d32b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index 7602331c7f8..a19dd6e5f83 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 849c240527e..cfc65f1cc6c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 47a43a0940a..6e8155de839 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 84713794535..333dd54c385 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 0d10de34a42..46a85905668 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 67faa2d8a41..d20fc1b2866 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index d17d933cf3c..9e583c438a6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 6b3b3c61b07..b821d3620eb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index e225c295bef..533cc2426b5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index 95ac0543d6d..3f76c032b8d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index a6920eef213..97e0e1276e0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index f12616e92f4..7c2d552df71 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index c2cd33efc55..4d6868f79f6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index e794084309a..f2459a1926d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index c19bd41e47b..868db222b59 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index d0214ece6ed..edd6ae60aab 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index e99a313acc0..f93a094c518 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index cdcd1c4f3ff..48b641e6201 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index db2776b055b..8889e7ad01a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index c44419f9ffa..23d7c7fca2a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 3b6cb2ae769..e44e7c1729d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 5d066cd771e..4e9d2352e80 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index fd8d125972f..327f983e7d4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 31012acd141..53a91e131b7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index 387f37b8422..47d3c168268 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 242580214f6..7422737f2e9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index bde8cca4c86..277894a3be8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index db3697eb1c5..f4dacad3a32 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index ae2a93a962b..63498095bb4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index dd7f59df0dc..f08f84439a1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index ee106219951..eee36023f99 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index f02e2ebe706..8521449208c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index ed1f9700a7d..ec015aeb9b1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index f2fe81f1b58..b5ac7ba3496 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index 4cbb7c95c80..b2688bafc73 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 32780119b66..db69241cb79 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index a31184e11f6..1d0592410a2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index b85e091a4e3..14aa71b9a70 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 00c3cb49989..17006b8286f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index 91171ccde56..828f4e7764a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index c3eb127118c..76d4a175f6b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index e84637ae3f4..642cae68e23 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 41783e42468..0827ced496e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index cdb373ab705..4315dd64da9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 7c78e27ee3d..2fa060a62ec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index f65f25b44a5..9e3e708eb0d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index fc0930e9d20..4ad880a81f5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index 2f89d16e8f4..484fcf648d9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 7de3b768698..15ea19f266c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index b2ab246f48e..e07f76a17f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 97272d3f57d..cd91d85770b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index a48c7d8a98d..e2d46a11b36 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index d7a50bf4568..cb39b16e7c2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 2a4abdb4c18..072ced8945a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 657f17cb714..f33a402f6fc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx index e2a92290d73..53b83da5fb3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index f7a7edb4d51..5550c955ae7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index 938fbdc2100..b72747f02bf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx index 5f9d89cfedc..0ae02b5af71 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx index 4281749ae32..ec48f3799c6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.mdx index 6337a0ef69f..025b51ba228 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index c54d09cc5e4..93429b8f14f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx index 10b286ce3b4..8b4791f2f91 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx index be546b9944d..a03933b4a1a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 5a5f7877d79..cee407326a3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx index 80716d7538c..fba2d97c4cb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx index dfc458a520e..03959c17afb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx index fc9aa139d34..a76db5851d9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay # ConvertIdToDelay - + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. Convert `qiskit.circuit.library.IGate` to a Convert `qiskit.circuit.Delay`. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index e3365df5f30..c86b49e61fb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 54e4de70312..0561250a0be 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index a308d5a8422..9ce6c43dc9d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index 29e5839a91f..7ee5d657b12 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 2f3e505d516..1d114beea2f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 4478758ea92..167949f56ea 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx index 658464ac2a1..ad26a58b3fd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Batch # Batch - + Class for running jobs in batch execution mode. Similar to a `session`, a Qiskit Runtime `batch` groups a collection of iterative calls to the quantum computer. Batch mode can shorten processing time if all jobs can be provided at the outset. To submit iterative jobs, use sessions instead. @@ -143,7 +143,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx index e49ce3e4460..3a4af5a7489 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx index 1c9beab2d03..e6859936a21 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx index 39b79bbb0e2..82223c9195a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 58a5aff88b2..bad2485c324 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -167,7 +167,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -397,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx index 3d09402ef24..0365e253ed2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx index e9c41f2f2c1..40d2103bd7a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx index 219af3e424c..caef36fc962 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx index d1624b9ff75..4f082c8f851 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx index bda52e1b030..78067457090 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx index e8edd9c85d9..b88b80181dd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx index 546a9b5501d..1d3600b5e14 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + Class for interacting with Qiskit Runtime Sampler primitive service. This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx index 1d6dc5fcadf..aa37d6a90a4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + Class for creating a Qiskit Runtime session. A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. @@ -138,7 +138,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index f8e4b5706b5..bc8868285ac 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 8c73f8b596c..a5d3efd8cf3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 5d4d62cf4ba..77e8c418c05 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index 2b4d53da8f8..c238e15c36b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 28644728eab..d3fed36e2ba 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index 7cd808d3509..ec29289776a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index a56e69e5d41..c0233cc89bc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 65b634385e1..a9c46a6b93a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 9c578bf3d58..91d903554b3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index 41d94d0a697..43ef720555a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 2b162049f1c..dfdc5c3420c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 5aa17e9ee36..bc1896f9f5e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 01324836e6d..6722247be0c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 56b66124d97..b7f500b437c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index 00bf747479c..de1e02d33dd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 89af08d371a..2c4b5b598b8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index a98d608ad69..bad685b3c4d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index 11fbef4abd2..8bed9d0a0e5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 1b24d24c896..966822fb119 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 4bc1e78e805..8c70b6c2606 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 7e3ea1aa5ef..bbd172a7c2b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 42c8b7f6bef..1fe7eb9584b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 0ea852b0401..378bb7eec2d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index d2de8d19dfc..15acbb7b486 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index b7f2691d333..c54752b3148 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index b9b0aed8a82..fd39506ed76 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 03a74a21de6..e262128ded3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index a6222dca8bb..1b221828f40 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 3e9fe792bfa..5bd7548b54c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 0034cce40fe..9e29e39e44e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index 734ce6195c5..014c583c139 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index f5df01db93d..7a592e99bb3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index baf44cf165a..f8e58b502b3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index d565b3bf5b0..d0d838ed045 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index dab8c5265c7..3c570faed2c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 3fe64b221e8..10e5fe0c308 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 7b5690e101d..da0f169520c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 9453915cfbf..2c0ae6062eb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index de318907c37..da6d5e3e975 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index abdab1132a3..d2b9269f6c1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index edc55f7df79..2339290d38c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index c439f3a3856..bd826fd05b9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index 9b67f1dbef6..c5e1db35f6d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 38c90c406d4..024682afcd0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 3e3574850ac..6b42b50c9fa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index e71938ce88b..8b52ccc81f4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 0cc5caffd1a..1d8910845de 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 010e37fff2e..c5131423d5e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index d399f52c2f0..088bd1ff8ac 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index f648ac62aca..47ac1fd85ab 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index 3aa2bf0b8b6..327f5cfd531 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 3e0d02a8695..a23092c117b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 5e2e2486dd2..e3a8d5d914c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 74dc663b507..f505dc31ef6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 7214dd6db5e..c6afe3d9377 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index c59706f0c96..cff321192ae 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index 3d870d190d7..e2f44f7d39d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 85762c1bd7d..6744f8ea3ce 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 106c351fca3..40ec800f1ea 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index 8db1286a66c..29ed9625d4f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index 980502d71ff..7ccaa2cafbe 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 5267fcf7db7..c9fcc6cd255 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 2f57dba08f4..fd72e350347 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index 1b434d8e95f..23db2133c07 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index f1c06bc4abc..23c56ae0ca2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index c061b389a94..f23560b9915 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 00e9b07dc16..de73704fa82 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 79932f12427..ec562ae585c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 32d980e8e64..616277fa92e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index 15f71628dee..cbeb9b65e98 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 8b3119ed8bd..cdf97288da1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 9068d3bb3d3..43f9e49f2d7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index a83840ea36f..1ab3aab2b4a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 8a5faa6b5ca..031e0c40d8a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index 23b8d02731a..c028efa707b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 9578ea539a7..21939967f34 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index 9ae3f9c68d5..16fff420bbf 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index a966e66a22f..7e0c3ab9f80 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 9e0a749bb56..a593effebcb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 6a7e14cb850..7c4960cb843 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 4f9b4f67992..02a91921f0a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index e6a0add6008..4cdf8bdc9bf 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 7f1d7b4a68a..0d3a62e3304 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 83c3551d3d7..8425f8419dd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index fd4a0fa4289..17e0741c1bb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index a0559dbdcf4..fdee7f88dd7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index 79ff9c03e8e..7cb270d0863 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index 8ac0126a7a8..1e5a73a39ad 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index f5aa962346a..719cc96fc64 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index 9030dbdcbc4..fff3d009cf7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index 94940db1e6a..703ea3b41bf 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index bea92db53a9..e5f1f6cb9df 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 555a05729d3..59d4595b5f2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index fa4bf75163a..13e99c3c9e2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 2f1a670e11c..49892d1379c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index cb326e770a7..523fe6674bd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index e4483912ece..550b1561e49 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index 289c3526d1b..cb4516d4882 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index b48ccf72ba3..b4b2618069a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index 78babbf843b..2c81984c812 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 380bad193c8..85bd8c54a44 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index cb47f21aef9..fda4666afad 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 8af3c47bd64..2bf35dcacce 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 47e8bd284b0..08dbb74636f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 25558cd1f14..2a12aba0521 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx index 164424a2f51..28d4c8eb750 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index 0bb72ca81a0..2c3c81da9f6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index fd1d43c73ed..961ff73b90e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx index 2bfd4e6e937..635adcdcec4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx index e10f35cb96f..f6722e8a319 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx index f550321b908..5b124b0500a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options for V1 primitives. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index fbf01ecd4f8..58e39d87c4b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx index 68e4dd30aa5..88e5ad07995 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx index fd033b19ed6..6acd471a427 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx index 18ffbe24f5a..43758734e9e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx index d1055f022e0..977ebf4b085 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx index a39fcc18d15..3bce87c1dee 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx index ac14f191987..edb51f866ca 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay # ConvertIdToDelay - + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. Convert `qiskit.circuit.library.IGate` to a Convert `qiskit.circuit.Delay`. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index df131fb7f27..bb5c420504b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 8c08c27bf3b..db270cb378f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index 49f1747d91f..f50b0fc2081 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index cb09f0df4b7..459f101facb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index beed36760d1..feade4548dd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 5ea0882e97f..4ec8461a9a3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.ai.AIRouting.mdx b/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.ai.AIRouting.mdx index 5b402de68ca..f2789268fd3 100644 --- a/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.ai.AIRouting.mdx +++ b/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.ai.AIRouting.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_transpiler_service.ai.AIRouting # AIRouting - + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.0)") ## Attributes diff --git a/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.transpiler_service.TranspilerService.mdx index 17bc8ef2186..092456ff28b 100644 --- a/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.transpiler_service.TranspilerService.mdx +++ b/docs/api/qiskit-transpiler-service/qiskit_transpiler_service.transpiler_service.TranspilerService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_transpiler_service.transpiler_service.TranspilerService # TranspilerService - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ## Methods diff --git a/docs/api/qiskit/0.19/logging.mdx b/docs/api/qiskit/0.19/logging.mdx index f03758c690f..2bb773e0e79 100644 --- a/docs/api/qiskit/0.19/logging.mdx +++ b/docs/api/qiskit/0.19/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.19/qiskit.aqua.AquaError.mdx index 4513928e823..97652f7e7f5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx index 1aeedce2e5d..563da9e5bf7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index c58dc452d21..edc471f9293 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055). This (original) version uses quantum phase estimation along with a set of m ancilla qubits to find an estimate, that is restricted to the grid diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx index 57050baae16..ac62b9b67f4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index c43703e59ed..184850059e3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # ClassicalAlgorithm - + Base class for Classical Algorithms. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index c4d3167bff8..ff1e2444bb3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx index c14f6c9adf9..501759d295f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx index 0c77cc70580..665eedaddf4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx index 15a696c0f6f..ed0707a8c5c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # Grover - + The Grover’s Search algorithm. Grover’s Search is a well known quantum algorithm for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx index 23852c7c409..ccd2cab7216 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -100,7 +100,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -119,7 +119,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -138,7 +138,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx index bb46cf1348b..17e2a25370a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It takes has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index 9427158843c..3ea818043f9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (QAE) algorithm, proposed in [https://arxiv.org/abs/1912.05559](https://arxiv.org/abs/1912.05559). The output of the algorithm is an estimate that, with at least probability 1 - alpha, differs by epsilon to the target value, where both alpha and epsilon can be specified. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 81ad5c91db8..af03188eec2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the an quantum amplitude estimation (QAE) algorithm without phase estimation, according to [https://arxiv.org/abs/1904.10246](https://arxiv.org/abs/1904.10246). In comparison to the original QAE algorithm ([https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)), this implementation relies solely on different powers of the Grover algorithm and does not require ancilla qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named MaximumLikelihoodAmplitudeEstimation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 4c130704983..c8e95287479 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 84252644690..b7eb39ac60f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Minimum Eigensolver Result. ## Attributes @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 783f00917f8..90d5513b096 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 0ae864a3b5b..ad1347cfd35 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 0ab5fa76d5a..9a26ceef0c4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx index 6b85fd6ffd7..58be638c37a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx index 75119f43977..c89860c95c4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx index f3c9afb94a5..10e7bc9cde1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx index 9b55a049d02..87b6bc0aeaf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -124,7 +124,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 11636835f9c..ec47851a193 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx index 79f9fc033ce..874accae6b9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx index 2850badbf93..6feeb133010 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.mdx index 817f78e5346..ea72f868a67 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx index 9f07760eb2e..63816bf5aeb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx index f96955706e0..e6ecb5df0be 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.mdx index 55f572cfd10..766a3534acb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.mdx index 3fbd8ceb7b7..d0240268422 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.mdx index 8996d76d962..fbff445e988 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.mdx index 0747f9b2dbb..c1507c69046 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.FixedValueComparator # FixedValueComparator - + *DEPRECATED.* Fixed Value Comparator diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.mdx index 29c1b2213af..cbf9db32243 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.circuits.FourierTransformCircuits # FourierTransformCircuits - + DEPRECATED. Quantum Fourier Transform Circuit. ## Methods ### construct\_circuit - + Construct the circuit representing the desired state vector. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.mdx index ba219ee2968..c121f47ef57 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.LinearRotation # LinearRotation - + *DEPRECATED.* Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index 7e0398d3ae6..56eb197c5fa 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.mdx index fc1dcd16368..b55e08ee0d2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PiecewiseLinearRotation # PiecewiseLinearRotation - + *DEPRECATED.* Piecewise-linearly-controlled rotation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.mdx index 107aafba73b..f5903581016 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PolynomialRotation # PolynomialRotation - + *DEPRECATED.* Polynomial rotation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.mdx index 0a32d49b0d9..cecf754fc28 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.mdx index 17f649a374f..9e5934bc515 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.mdx index 0e2e669c704..551997b8287 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -66,13 +66,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.mdx index 3bb921c9fdc..47bc4400552 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on [`QFT`](qiskit.aqua.components.qfts#module-qiskit.aqua.components.qfts "qiskit.aqua.components.qfts") and [`IQFT`](qiskit.aqua.components.iqfts#module-qiskit.aqua.components.iqfts "qiskit.aqua.components.iqfts") components. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 04f22a0beab..4d8844e249c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -57,13 +57,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.mdx index c38144e111c..6247bd5103e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FirstOrderExpansion # FirstOrderExpansion - + DEPRECATED. First Order Expansion feature map. This is a sub-class of [`PauliZExpansion`](qiskit.aqua.components.feature_maps.PauliZExpansion "qiskit.aqua.components.feature_maps.PauliZExpansion") where *z\_order* is fixed at 1. As a result the first order expansion will be a feature map without entangling gates. @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FirstOrderExpansion ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.mdx index 17b79f6d4da..fd15d2d563e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliExpansion # PauliExpansion - + DEPRECATED. The Pauli Expansion feature map. Refer to [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) for details. @@ -79,13 +79,13 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliExpansion ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.mdx index 41bd3ac4ebd..7a7dc6ed0b8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliZExpansion # PauliZExpansion - + DEPRECATED. The Pauli Z Expansion feature map. This is a sub-class of the general [`PauliExpansion`](qiskit.aqua.components.feature_maps.PauliExpansion "qiskit.aqua.components.feature_maps.PauliExpansion") but where the pauli string is fixed to only contain Z and where *paulis* is now created for the superclass as per the given *z\_order*. So with default of 2 this creates \[‘Z’, ‘ZZ’] which also happens to be the default of the superclass. A *z\_order* of 3 would be \[‘Z’, ‘ZZ’, ‘ZZZ’] and so on. @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliZExpansion ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index d6bb5ccd088..75aae334a58 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -66,13 +66,13 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.mdx index ef43aa7d81c..8601aa274f5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.SecondOrderExpansion # SecondOrderExpansion - + DEPRECATED. Second Order Expansion feature map. This is a sub-class of [`PauliZExpansion`](qiskit.aqua.components.feature_maps.PauliZExpansion "qiskit.aqua.components.feature_maps.PauliZExpansion") where *z\_order* is fixed at 2. @@ -70,13 +70,13 @@ python_api_name: qiskit.aqua.components.feature_maps.SecondOrderExpansion ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.mdx index 00ae6d1180f..e3e71e0a57e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.mdx index c3f8883c7d7..c07cb2299da 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.mdx index 90adbb299df..83effe33864 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.mdx index b1ffa46ab36..160cd827cd5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.mdx index 9f46aa177cf..87cda7a6f50 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.iqfts.Approximate # Approximate - + The Approximate IQFT. This form of IQFT generates the inverse of an Approximate Quantum Fourier Transform as described in [https://arxiv.org/abs/1803.04933](https://arxiv.org/abs/1803.04933). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.mdx index 5c6f1879257..cdbf4bbde2d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.iqfts.IQFT # IQFT - + DEPRECATED. Base class for IQFT. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.mdx index e3221deb2ca..1b0ebad161d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.iqfts.Standard # Standard - + The Standard IQFT. The standard version of the IQFT is simply the inverse of a plain QFT. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index dc8b0136dd6..1443548167e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 18e76f1aeb5..4cb53cbedc1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index c3e074ec0a0..8d34866f98f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index f543582f9c8..532d8dcdc2b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index bde59559f17..f262dd3aa47 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 7d85dc4e2b2..f5fbf5b36d8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -38,13 +38,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_seed - + Set seed. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 0a3cd8d8390..3387dda6e06 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # NumPyDiscriminator - + Discriminator based on NumPy **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 8353f900ff9..2608f7582cf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index af6242f2466..d0a40855cfd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.mdx index 3aa3752275f..82aae8775c1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # ADAM - + Adam and AMSGRAD optimizer. **Adam** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.mdx index c202388068c..75d94f67626 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # AQGD - + Analytic Quantum Gradient Descent (AQGD) optimizer. Performs gradient descent optimization with a momentum term and analytic gradients for parametrized quantum gates, i.e. Pauli Rotations. See, for example: @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -247,7 +247,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.mdx index 7b1eb4bf315..1fb2e7a27bb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.mdx index 8bf46be0af2..918b152d332 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.mdx index e8663c269c1..3c8f7d3c186 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 158cf63c7ff..13f02ac066d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index c1250401345..705bd6eed82 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.mdx index 4eed7eca56c..a4874ef655b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.mdx index f11b4ec7d1a..aedb38a9abc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -148,7 +148,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -295,7 +295,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.mdx index 47a1718f1a7..817df0fc958 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index ec06850c7db..3596eeddafd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index 62a71c5c14d..5ca8fd466aa 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx index 744aeda0a7c..e0c837d860b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.mdx index 456abdef31e..385e7b787c5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -97,13 +97,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -124,7 +124,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -172,7 +172,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.mdx index 6454f07bcd2..c28b7ddef19 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.mdx index 2bf16eb684e..d6f8f50914d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.mdx index e574b33f648..430707579ac 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -184,7 +184,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.mdx index e25811c6fc6..bbceccdeaa3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -198,7 +198,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.mdx index 4e9069b13f7..9b137295c34 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index 596aa5d00d1..0ed2a9e6580 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index d8faae89ec1..cfca689b5cd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.mdx index 4cc682c6095..e02711c86d2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### construct\_circuit - + Construct the oracle circuit. **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.mdx index eb00f457e4c..72617ac6834 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.mdx index fb332cc5a53..214fccafd52 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.qfts.Approximate # Approximate - + The Approximate QFT. This is an Approximate Quantum Fourier Transform as described in [https://arxiv.org/abs/1803.04933](https://arxiv.org/abs/1803.04933). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.mdx index b2b423f350d..5536b2a067f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.qfts.QFT # QFT - + DEPRECATED. Base class for QFT. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.mdx index bedffee8eaa..0f03a3527a7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.qfts.Standard # Standard - + The Standard QFT. This is a standard Quantum Fourier Transform diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.mdx index dbc6d15a866..cf8cbb7e942 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.mdx index cef525b6d73..a0b684a22b6 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 4b8e4563010..e9939acc67b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 0249dbd3b03..4b3448bbe26 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 9c048c8be3f..06adeb98bbc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 4f8eea0518d..2e0b6241944 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index 87184c5c921..ec7ccc21500 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 20cf92226bd..f5d5a43846e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index fdfba872b5e..8ce947d7723 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -161,7 +161,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 0fd9bf758b5..4c9be0c9172 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index bce853547b7..609870c85d1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 86479a508e1..765e32eab27 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index 196c406865a..7761be5884c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # UncertaintyModel - + The abstract Uncertainty Model ## Attributes @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index e438464abaf..f423fc4679a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index 3ddc5c2043b..bbe42c069ee 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 46a4c70f43b..9b4f0a7d829 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index 613ea22945c..e9d5026442b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index 9e5b87eebff..09b6454c15f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # UncertaintyProblem - + The abstract Uncertainty Problem component. ## Attributes @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index adc2c0c61db..7732808ec02 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index 5de4f2fbac3..71606227e45 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # UnivariateProblem - + Univariate uncertainty problem. Constructor. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.mdx index 94a7cbd3c3c..8704567524b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.RY # RY - + DEPRECATED. The RY Variational Form. The RY trial wave function is layers of $y$ rotations with entanglements. When none of qubits are unentangled to other qubits the number of parameters and the entanglement gates themselves have no additional parameters, the number of optimizer parameters this form creates and uses is given by $q \times (d + 1)$, where $q$ is the total number of qubits and $d$ is the depth of the circuit. @@ -133,13 +133,13 @@ python_api_name: qiskit.aqua.components.variational_forms.RY ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.mdx index f0ab3497bd3..4b780146292 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.RYRZ # RYRZ - + DEPRECATED. The RYRZ Variational Form. The RYRZ trial wave function is layers of $y$ plus $z$ rotations with entanglements. When none of qubits are unentangled to other qubits, the number of optimizer parameters this form creates and uses is given by $q \times (d + 1) \times 2$, where $q$ is the total number of qubits and $d$ is the depth of the circuit. Nonetheless, in some cases, if an entangler\_map does not include all qubits, that is, some qubits are not entangled by other qubits. The number of parameters is reduced by $d \times q' \times 2$ where $q'$ is the number of unentangled qubits. This is because adding more parameters to the unentangled qubits only introduce overhead without bringing any benefit; furthermore, theoretically, applying multiple Ry and Rz gates in a row can be reduced to a single Ry gate and one Rz gate with the summed rotation angles. @@ -122,13 +122,13 @@ python_api_name: qiskit.aqua.components.variational_forms.RYRZ ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.mdx index 066a98e2560..b0f1417a3a1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.SwapRZ # SwapRZ - + DEPRECATED. The SwapRZ Variational Form. This trial wave function is layers of swap plus $z$ rotations with entanglements. It was designed principally to be a particle-preserving variational form for [`qiskit.chemistry`](qiskit_chemistry#module-qiskit.chemistry "qiskit.chemistry"). Given an initial state as a set of 1’s and 0’s it will preserve the number of 1’s - where for chemistry a 1 will indicate a particle. @@ -127,13 +127,13 @@ python_api_name: qiskit.aqua.components.variational_forms.SwapRZ ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.mdx index e8dad1f0112..69b6d466fed 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -106,13 +106,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx index fd5346c83fd..52c2ec8dac4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). **Parameters** @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -267,7 +267,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -285,7 +285,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.mdx index abc52d18cf9..b40286bb532 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.mdx index 7896617f3e2..52759ae58b8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.mdx index 9ca8001f7a4..ee6068abde5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ## Methods ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 9821647f4fe..fa4491aa99d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 146ed919032..154736b19f2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -224,7 +224,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index 495db564927..88eab06710e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index c116abc60c2..c6beccb3cdf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ## Methods ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index aba216e379b..ef26cfc79fe 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 4f55795a7dc..9dc1cbf7d32 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 1e92ed9cf05..94b8362930c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.mdx index b2870e97c22..db88c30ef17 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.mdx index d8d5e60af36..bc3b5dad5b2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.mdx index 4a34704f4e3..111ada60ee8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index b403809aed8..93cc93a8ed6 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ## Attributes @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 655c373c13c..e7d6e8f0647 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ## Methods ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index cd02ef81099..fe9f0977572 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 6d0a04f8d0c..96a862ac31b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ## Methods ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index 80917b64bdf..a945388f6de 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ## Methods ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index 79e0f90973f..5a1b2805909 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.mdx index ecb35f8b7ba..cbdcfab598c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index 4a7943ee4fe..eac92737c53 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. @@ -43,47 +43,47 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### \_\_mul\_\_ - + Overload \* ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 18fd8f6ee02..3fb185cd5fc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # MatrixOperator - + Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.mdx index 5d838fc8f7a..ea987fc5273 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # PauliGraph - + Pauli Graph. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index deec27b47a4..8c6950874af 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -313,7 +313,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -348,7 +348,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -367,7 +367,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -494,7 +494,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -562,7 +562,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 3c62a94a8d6..c019107a29b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -293,7 +293,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -328,7 +328,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index f857638fa51..bf1fe86293d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # Z2Symmetries - + Z2 Symmetries **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Returns** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 2bc897d6bec..e77ccd7d6b4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.mdx index c1bea08ba1a..accb664587b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.mdx index 82b3a6235f7..84bd468d6ad 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.mdx index ed05f382a26..fcaa879d2fa 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index d8bc30c3475..f40d7d7603f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index 1eec3dd0240..d134ee2e2af 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index d01173698d7..94839e1eed4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 3d6f741707b..09ec65fa080 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index 6bcc62ae1c1..c87fcc04be2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.mdx index ade0edc6df6..13e86c6a11f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 5a1c2979f7f..c504df5eada 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.mdx index 53d61d882af..2b4667fcedc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # StateFn - + A class for representing state functions and measurements. 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. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 64cc4112590..e86469bc721 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.mdx index 2355b2cb156..215bb19ecec 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # CircuitFactory - + Base class for CircuitFactories ## Attributes @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.mdx index dd79604e0af..e0466d9a87e 100644 --- a/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Class for Run Configuration. ### shots @@ -76,7 +76,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.mdx index 1dc33505594..ed725457aa3 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.mdx index 7f65518859a..d36fa48df7f 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx index 1a1408b28c4..40ca30e04c3 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # QMolecule - + Molecule data class containing driver result. When one of the chemistry `drivers` is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.QMolecule ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -129,7 +129,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -162,7 +162,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -185,7 +185,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -206,6 +206,6 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.mdx index b7b97d64f11..3baa997024a 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # QiskitChemistryError - + Base class for errors raised by the QiskitChemistry SDK. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx index 8f2885b01c0..516c245ac84 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # QEomEE - + QEomEE algorithm (classical) **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx index 793b3cb256e..262c065abe5 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # QEomVQE - + QEomVQE algorithm **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx index 66293afa759..0874e3b4b91 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # VQEAdapt - + The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.mdx index c50d53908fe..26ae7c3a6f1 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # HartreeFock - + A Hartree-Fock initial state. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.mdx index 3540976b00b..e342ce374dd 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -145,7 +145,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -217,13 +217,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -326,7 +326,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx index 5192e0807b2..dde8bb264f8 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # ChemistryOperator - + Base class for ChemistryOperator. ## Attributes @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx index f40f68cc63b..0f7a3a2c370 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx index 142dc500099..4056efebd00 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -93,7 +93,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index dc526fe9911..cb285754dfb 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 569f64e7989..06b590b49d9 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -283,7 +283,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx index cf94a8c54f8..272b3d7aa22 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # QubitMappingType - + QubitMappingType enum ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx index 2c65c8c15e0..890de8da08a 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # TransformationType - + Transformation Type enum ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx index 232ff4be0a9..b53deb0fff9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Implement a classical register. Create a new generic register. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Clbit.mdx index fcafe1c3c74..1e39bda27ce 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Implement a classical bit. Creates a classical bit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx index 947c403d6b4..ea687abc760 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.mdx index ae1f61deac3..8712faa4d14 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx index 6adbf49d2bc..f132c2227b1 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Unitary gate. Create a new gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Instruction.mdx index 6b1c26ef616..67db35b0d5d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Generic quantum instruction. Create a new instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.mdx index fe01a915e85..0a0a55e2828 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Measure.mdx index eb42369c5a0..d23c063efb1 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Quantum measurement in the computational basis. Create new measurement instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Parameter.mdx index e1195f222a9..893522fadb7 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Parameter Class for variable parameters. Create a new ParameterExpression. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.mdx index 2e183a49233..bb463357ce9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new ParameterExpression. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.mdx index c4318b7bb2c..b836f4c8f67 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + ParameterVector class to quickly generate lists of parameters. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx index cb04843cfe9..b764dc29e9b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -355,7 +355,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -391,13 +391,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -838,7 +838,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -856,7 +856,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx index 87af09e85a2..f6fdca3a152 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Implement a quantum register. Create a new generic register. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Qubit.mdx index 50bd0b5651c..9e97dd2ee23 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Implement a quantum bit. Creates a qubit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Reset.mdx index 1ff1d74859e..85007856b46 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Qubit reset. Create new reset instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx index 72b461b75bf..94a75c3590f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -301,13 +301,13 @@ python_api_name: qiskit.circuit.library.AND ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -748,7 +748,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -766,7 +766,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.mdx index 9a7ea6219d4..15fb5bfb928 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Barrier instruction. Create new barrier instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx index d0df52232fc..178eb9f2823 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + The 3-qubit controlled X gate. This implementation is based on Page 17 of \[1]. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx index a1fdfddc31e..a3312a28b53 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1]. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx index fdd922d3e6b..127a431b569 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx index f0be46e4222..baed4813633 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx index 3e8de5cb31d..01d605d03cd 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Controlled-RX gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx index c2a98f5bb86..f93a37cfded 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Controlled-RY gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx index c50ca54f699..fb4dd45aede 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx index 4dc76bb38e8..5acaf4a9fcc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Controlled-X gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx index 45c01c152d6..2158daa356a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx index 0a7aa0fb266..144e7b0d567 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx index 1846fb1dbaa..1791da88205 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Controlled-X gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx index a561007c3c4..290f6839992 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Controlled-Y gate. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx index bcce88db268..d2dff759228 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx index 1b41b63c1a0..f94d2191e6b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx index 0ae9ea9da8d..f71602c733c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Diagonal circuit. Circuit symbol: @@ -297,7 +297,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -333,13 +333,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -780,7 +780,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -798,7 +798,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx index 3c3c1f75025..cfabc1f0ed1 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -494,7 +494,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -530,13 +530,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -977,7 +977,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -995,7 +995,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx index 469eae992f0..5155ab174c2 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + The heurisitic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -512,7 +512,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -548,13 +548,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -995,7 +995,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1013,7 +1013,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx index d297f53ee31..e76f8a9f183 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -314,13 +314,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -761,7 +761,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -779,7 +779,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx index 77787ed95b6..5fb14045e0d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -309,7 +309,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -345,13 +345,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -792,7 +792,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -810,7 +810,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx index a335c146249..c786799197a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -287,7 +287,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -323,13 +323,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -770,7 +770,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -788,7 +788,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx index f6927faa31a..69c0547b282 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -281,7 +281,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -317,13 +317,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -764,7 +764,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -782,7 +782,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx index 5051fccef10..fbe37a94e7d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx index 5954999a92f..918b325ffec 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -285,7 +285,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -321,13 +321,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -768,7 +768,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -786,7 +786,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx index 2f75d52cf53..3e1897fe8aa 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx index f8e2084db85..14a0804d79c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -277,7 +277,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -313,13 +313,13 @@ python_api_name: qiskit.circuit.library.IQP ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -760,7 +760,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -778,7 +778,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx index 4b38f69ca77..768757df3d8 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + An n\_qubit circuit that computes the inner product of two registers. Return a circuit to compute the inner product of 2 n-qubit registers. @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -297,13 +297,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -744,7 +744,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -762,7 +762,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx index 81161467dfd..77bb6083f39 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on parameters): @@ -330,7 +330,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -366,13 +366,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -813,7 +813,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -831,7 +831,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx index 567f724b411..66877910d0f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -364,7 +364,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -400,13 +400,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -847,7 +847,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -865,7 +865,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx index 44bd4949e64..450ba90abc8 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. This default implementations requires no ancilla qubits, by broadcasting the target gate to the number of target qubits and using Qiskit’s generic control routine to control the broadcasted target on the control qubits. If ancilla qubits are available, a more efficient variant using the so-called V-chain decomposition can be used. This is implemented in [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain"). @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -308,13 +308,13 @@ python_api_name: qiskit.circuit.library.MCMT ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -761,7 +761,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -779,7 +779,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx index 1b37f33af1d..454944efef0 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + The MCMT implementation using the CCX V-chain. Create a new multi-control multi-target gate. @@ -270,7 +270,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -306,13 +306,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -759,7 +759,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -777,7 +777,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx index cac7fe4a715..c5706453a33 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Global Mølmer–Sørensen gate. The Mølmer–Sørensen gate is native to ion-trap systems. The global MS can be applied to multiple ions to entangle multiple qubits simultaneously. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.mdx index 4a229e90778..564dce0d21d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Quantum measurement in the computational basis. Create new measurement instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx index 04e79980ff2..44dc96b8d78 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -484,7 +484,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -520,13 +520,13 @@ python_api_name: qiskit.circuit.library.NLocal ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -967,7 +967,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -985,7 +985,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx index ee4b8c3b3ed..8925bb42b8d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -301,13 +301,13 @@ python_api_name: qiskit.circuit.library.OR ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -748,7 +748,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -766,7 +766,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx index f18aee1d1ec..09ce0d650fb 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -531,7 +531,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -567,13 +567,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -1014,7 +1014,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1032,7 +1032,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx index ceff4bc3c6e..6146d6f782f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -269,7 +269,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -305,13 +305,13 @@ python_api_name: qiskit.circuit.library.Permutation ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -752,7 +752,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -770,7 +770,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 3440f4f19dd..3289d9e4e33 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -401,7 +401,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -437,13 +437,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx index 44292cec92d..d569b2b4e1b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -375,7 +375,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -411,13 +411,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -858,7 +858,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -876,7 +876,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx index f5c53352fef..5e89b0e5457 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -338,7 +338,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -374,13 +374,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -821,7 +821,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -839,7 +839,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx index f93c7e66edf..30142456942 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -274,7 +274,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -310,13 +310,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -757,7 +757,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -775,7 +775,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx index 046f0d41b2d..3aa86e23f67 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx index 90e9b3f7e44..90875202a1d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx index 03b5ba3c5dc..fd2f9f2e604 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx index bb59558babc..5d4582783e3 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + A parameteric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx index 3d9e10a2ade..9556eb7a0ad 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx index e5410087d70..50fee0cf142 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + A parameteric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx index 362eb847533..781bbb783a0 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx index c9b6e0f3d84..5c1d66be059 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + A parameteric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx index 6339ce9eecf..8b68c3e27bc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + A parameteric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx index ad0a596456d..253e621761d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + The RealAmplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. @@ -521,7 +521,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -557,13 +557,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -1004,7 +1004,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1022,7 +1022,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.mdx index 9a82f58d063..ca67a36ec74 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Qubit reset. Create new reset instruction. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx index be640b84c15..dc2a750f97a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx index 1f42dbcb681..4c9c969617b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx index 3509dba7522..caa9d910546 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx index 4c17b812f5a..f62754e67c9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx index 695577ca118..7eb3e38a9aa 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx index ddb6a7b0739..9d6c737e736 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -542,7 +542,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -578,13 +578,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -1025,7 +1025,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1043,7 +1043,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx index 265e6779387..0fec610d367 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx index f47a3debe7b..00cae31f509 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx index bccdc03aaf0..c7cc3ed68b8 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx index 7aa5d29f4a3..676151b1510 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -394,7 +394,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -430,13 +430,13 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -877,7 +877,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -895,7 +895,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx index 97a8eedc49e..0f921fedb9b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx index e496f701961..f04195ced2d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -269,7 +269,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -305,13 +305,13 @@ python_api_name: qiskit.circuit.library.XOR ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -752,7 +752,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -770,7 +770,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx index eed3dc5615c..3cb3acae4ca 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx index e30f89431de..8855fbd6176 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -504,7 +504,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -540,13 +540,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -987,7 +987,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1005,7 +1005,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx index 66991662901..af5902c670a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx index 6190bb90583..e95b660dab4 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -491,7 +491,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -527,13 +527,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx index 4aa44cd476b..fcf5c4c7d3f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.mdx index c36696ff419..becffed2c02 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.mdx index ddfa10ff51b..46e26d00b99 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.mdx index 053f1a1e705..45cf8e2c79d 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -59,7 +59,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx index 3d4a8a7ccf0..383225a9a09 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t diff --git a/docs/api/qiskit/0.19/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.19/qiskit.extensions.Initialize.mdx index a78e56ea722..844ad630f9f 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers (assuming the qubits are in the zero state). Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.mdx index b56e117b8cd..09c50957646 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx index ad18fced8a9..fad61b89fea 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. diff --git a/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.mdx index a2f0fc35809..8a01d41aa0f 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 90daedebdb5..3dbaf9fe9e1 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 8c75cf62dc9..b825604060f 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 0e25cb40fc9..c76ceb342ea 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.mdx index 62b4b839397..c33f1a67b05 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -115,7 +115,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.mdx index 780b308e3d7..6d689c8bf7d 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data_providers/time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.mdx index 3e0304cb034..9a146c56bdc 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataType # DataType - + Data Type Enum ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.mdx index 7a7db92ba57..dee3cd94f3b 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data_providers/time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.mdx index 7609ad11270..c91fe11273e 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type stockmarket: [`StockMarket`](qiskit.finance.data_providers.StockMarket "qiskit.finance.data_providers._base_data_provider.StockMarket") :param stockmarket: RANDOM :type start: \ :param start: first data point :type end: \ :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.mdx index 8d4efebf38c..2721224aa2c 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # StockMarket - + Stock Market enum ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 4b5f48819f8..d379da0f55d 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.14.x/qiskit/advanced/aqua/finance/data_providers/time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx index b0643c7c56b..311121b9651 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx index c1fe7daad2d..38cdfce7839 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 297fa0c4ed4..e3e013736f0 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx index 7313acf6d4a..ea619a90a1e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 2a7320e25b7..0033e9d6c14 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx index 99b6d1df94b..242fde8643d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx index bc38d2496f3..963cfb964dd 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx index 7cf72d52c3a..00620471efc 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx index dbae1c5d616..539e5e91cc4 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx index a16a1adcc8a..d77acb17470 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx index 377dbe7c933..df719c80851 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx index c67e04d6922..1e8bb3473a8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + ZZ fitter ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.mdx index 2190ced2458..47404a218b0 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx index f9c0e8cc896..84538013b11 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.mdx index 15925978316..a8aec81620c 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.mdx index 9f39246a051..40843d2c50c 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 4a53e4505b1..dc57e0b8570 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -72,7 +72,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 59d8f3ac0de..fc234bb119e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index ca085122952..630fc56a6f9 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index fb381aed694..788a70d4e8a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index b52e904a067..fa3bee2839b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.mdx index 7efd57e4bda..4d2baa59e52 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.mdx index 93a9f6f4398..8e921259bb8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 65436223ff7..f4e9aa91494 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.mdx index 02dc77caf43..9439035db43 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx index 850ed829034..5dff2e31187 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.mdx index 78e35ba2742..879f7332d87 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.mdx @@ -8,68 +8,68 @@ python_api_name: qiskit.ignis.verification.BasicUtils # BasicUtils - + Abstract base class (ABS) for utils for various groups and sets of gates for randomized benchmarking. ## Methods ### compose\_gates - + Compose group elements. ### elmnt - + Return a group element. ### elmnt\_key - + Return a key of a group element in the table. ### find\_inverse\_gates - + Compute an inverse of a group element. ### find\_key - + Return a key to the group element. ### gatelist - + Return a list of gates corresponding to a group element. ### group\_tables - + Return the group tables. ### load\_tables - + Load pickled group tables, or generate them if they do not exist. ### num\_qubits - + Return the number of qubits. ### random\_gates - + Pick a random group element. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.mdx index 03e3b3edfc2..9dfe8f11eac 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on n qubits is generated by the gates CNOT, T and X. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index badbaf478f8..d1cb4c0e5d1 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.mdx index 402fbf70bce..3967ef08840 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Clifford # Clifford - + Clifford Operator Class. ## Attributes @@ -65,7 +65,7 @@ python_api_name: qiskit.ignis.verification.Clifford ### from\_dict - + Load a Clifford from a dictionary. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.mdx index 40f54643751..6e50fccf911 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CliffordUtils # CliffordUtils - + Class for util functions for the Clifford group. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.mdx index b47cb746b74..bf3273b5fed 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.DihedralUtils # DihedralUtils - + Class for util functions for the CNOT-dihedral group. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.mdx index 14be7c540ae..06b9dd6693d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.mdx index 6ad25a5a16c..c6d437ec885 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.mdx index bd84526b4fd..6daf21b7767 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.mdx index 012d715e37c..cef6375504d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -74,7 +74,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.mdx index 3f322e254d7..4060d387b90 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Class for fitters for quantum volume. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.mdx index ff63a8f300b..9ba8b08bc6f 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Class for fitters for randomized benchmarking. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.mdx index 9f6610b7e5d..a6fd7bf7580 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.mdx index ba5093361dd..33458a8e5a2 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.mdx index dedc6b4355b..1fc555c2e7f 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.mdx index 0341b0096a3..e0a3874902a 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx index 16b7314d56d..e9c8bc63bd5 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 0e44e3c88cb..e1dda6b700d 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 675ca882ff2..db414305d95 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx index 3791c51a3cb..9859f7febb0 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx index 4ef7057ab55..6bed5c6e10a 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index 13188c3c298..8db6184d893 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index f2fd5ea6787..41830c25684 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ## Methods ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index a885005cd18..cabc9b57014 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx index 9b4d33d54e0..f9b7ef90ace 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx @@ -32,7 +32,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.mdx index a6547ba95f2..26093346995 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.mdx index 0b9f9abdfc3..caf3f8fc752 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.mdx index 7eed86aef10..8f544050b5d 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IsingToQuadraticProgram # IsingToQuadraticProgram - + Convert a qubit operator into a quadratic program **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index d77270a1d90..292dec77926 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.mdx index 0eb612aaa22..2a64db50e89 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToIsing # QuadraticProgramToIsing - + Convert an optimization problem into a qubit operator. Initialize the internal data structure. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.mdx index 887001fafa5..9ff8b079f99 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToNegativeValueO # QuadraticProgramToNegativeValueOracle - + Converts an optimization problem (QUBO) to a negative value oracle. In addition, a state preparation operator is generated from the coefficients and constant of a QUBO, which can be used to encode the function into a quantum state. In conjunction, this oracle and operator can be used to flag the negative values of a QUBO encoded in a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index 3c7ec9564e8..97a251ff037 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -70,7 +70,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx index 1696fbc8868..e098008ab0d 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -82,7 +82,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx index c0dde088c1e..23913447a1c 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # LinearConstraint - + Representation of a linear constraint. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx index 6150b265adb..55671ddbea6 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx index e0f53ed6a13..6bad98f31b9 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx index 88968b4bebd..542659cad2f 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx index 7a19e4a4562..d9a9fbe7e53 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx index 5d1edd422d3..aca501c561d 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx index 6d74515b7ef..41a3ce00901 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # Variable - + Representation of a variable. Creates a new Variable. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.mdx index 70e0a8826ba..f30cb0ebfc0 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.mdx index 89b665ec672..4ddb6f2cf92 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Base class for backends. Base class for backends. @@ -84,7 +84,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.19/qiskit.providers.BaseJob.mdx index 12212a9593f..5b17d49248e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Class to handle asynchronous jobs Initializes the asynchronous job. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -78,7 +78,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -94,13 +94,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.mdx index 3997589a719..2dbed516a3c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Base class for a Backend Provider. ## Methods ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.19/qiskit.providers.JobError.mdx index 4203c697d95..6071e92cd9b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx index 317e8b80c74..4d6968c2bb6 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Class for job status enumerated type. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.mdx index 3fc5f7e1103..6e32d2ad981 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.mdx index 21d2e505acf..2cdb390ce5b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.mdx index 3ab8029ed70..5bca3dbdf40 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.mdx index 620df51749d..f23c45364c1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.mdx index 43c65cb8713..21f00b951aa 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Provider for Qiskit Aer backends. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx index bd4bc0a0d1e..3d626dae996 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx index 94167f1a372..ad2f2a4246c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Noisy quantum circuit simulator backend. The QasmSimulator supports multiple simulation methods and configurable options for each simulation method. These options are specified in a dictionary which may be passed to the simulator using the `backend_options` kwarg for [`QasmSimulator.run()`](qiskit.providers.aer.QasmSimulator#run "qiskit.providers.aer.QasmSimulator.run") or `qiskit.execute`. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx index dc3a26426f0..3c3605c3786 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Ideal quantum circuit statevector simulator **Backend options** diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx index b2aea1b22c7..3ba9d372ebe 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Ideal quantum circuit unitary simulator. **Backend options** diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.mdx index 38179bf191f..27d3a6c9555 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -118,7 +118,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index c3e6f8ee4e5..e5ae238d530 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -115,7 +115,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index db8c726f60d..ef56d362a5b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create a probability snapshot instruction. @@ -117,7 +117,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index bdc0f9db86a..af3c648ece1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -116,7 +116,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 487629ffd43..0c340fe33d5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index acda15bd828..df235b53b0a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.mdx index ca2eade4c42..3a867bab8e5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.mdx index 63de086f5a8..e2783af14d7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -220,13 +220,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.mdx index e6f32b05fa4..9d420f75165 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -181,13 +181,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 40b6f67e6ff..4af0cf4b343 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.mdx index 02a583c3f74..644e1aff5c7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ## Methods @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -80,13 +80,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -161,7 +161,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -184,7 +184,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.mdx index 4669bf9ba8c..dedaf65b1c2 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.mdx index e2fc73d120f..dcec2cf5900 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + BasicAerJob class. ### \_executor diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.mdx index 46d92031538..93aff116a3f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Provider for Basic Aer backends. ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 81971329df0..3925fa5fdbe 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Python implementation of a qasm simulator. Base class for backends. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 32710eec753..b193609d77c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Python statevector simulator. Base class for backends. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 747903954fb..71acf881fff 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Python implementation of a unitary simulator. Base class for backends. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.mdx index 7d70d3f861c..d5536d344ca 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience backends available to this account. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.mdx index 6ba8f69abf7..0f77b9b4b2b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index a54586c9f95..f5121277334 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index fd261c2729d..b6610bcf3a1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 0393d91a1c9..dd53f56432a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 448fe50ce64..24ec86eef02 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.mdx index 87c26c79fa9..486ea54eae5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index d12e46047e3..8d5b0b9a7e3 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.mdx index a346a03170a..2da2aee5562 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method after assembling them into the [`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj") format. The [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 16717606248..2d51729f5ad 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 1aa0b0d5b82..b56e1d4900f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.mdx index 8bd0fced5da..db1331eae9b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.mdx index a401c2b6128..b52fc8b3ec9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 0f9a887b49a..12b4aba9453 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.mdx index 110de766921..a64bf8edc95 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.mdx index 6d1a362ae44..84f719c2bff 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -209,7 +209,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.mdx index 26f7af3443c..7a975fd43d4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.mdx index 6b5d177f7d7..bcd3facfb53 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.mdx index f8d4d458a1b..3ae180efb3a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index abb14dc99d0..df25afc5aad 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 2b853e78f21..7871874ad4f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.mdx index 1044100ca02..a7cee57c79e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -149,7 +149,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### from\_dict - + Deserialize a dictionary of simple types into an instance of this class. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 0fc94859622..01cd7dd89c2 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.mdx index 6092757f10b..9f473444692 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 4fc488f7ea8..0d0c8cd0c0c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 93d54bb20fc..3571c553755 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index c57c433342d..3dfff03559b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.mdx index 8db776cb9e3..7f2bcabb8d0 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Queue information for a job. ### position diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 5422a1f9af8..03c26e90ee9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index fee68f11e18..877935f4704 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 637447b5737..eb4cd416c93 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 083ee65103d..bd38983fd33 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index f6f37e31dd8..a044287e9e4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 7f7435ff55a..cd287859f7e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 9a8554640e0..948a5882e2d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.mdx index 409160878e6..f5d585f3879 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index ff9859996bd..3fa25d9b9ad 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](qiskit.providers.ibmq.managed.ManagedJobSet#results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](qiskit.providers.ibmq.managed.ManagedJobSet#cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.mdx index d04e56d691d..01776b0c030 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.mdx index 5889c5e40ff..45ab4e84e30 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.mdx index ce87ca08241..36769ab2349 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general propeties of the backend. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx index b9dabac6f97..7fbf8c4eba3 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -35,7 +35,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.Command.mdx index 7bfe81ac03a..b5366c366e8 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Class representing a Command. ### name @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.mdx index b24cb0e9b9a..89178d144fd 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Class representing a Gate Configuration ### name @@ -45,7 +45,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.mdx index 2b2e22986b8..5cdd26e963f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Model for JobStatus. ### job\_id @@ -45,7 +45,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx index 585383e67de..ee7c20f6cb4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.mdx index 43040625b1e..fb4009e537d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. @@ -48,7 +48,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.mdx index 32c93954461..eddf9994438 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.mdx index 4cf1083312a..37f0873d523 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Class representing a U Channel LO ### q @@ -38,7 +38,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx index 83b763be6cf..e663a8e5363 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), diff --git a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx index 72267270b2b..3bfb0a44716 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # AcquireChannel - + Acquire channels are used to collect data. Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx index 59160c46733..fd339348e00 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # Constant - + A simple constant pulse, with an amplitude value and a duration: $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx index 80140cc1ff2..cab0965174a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx index 66d60ab00dd..dc278096a91 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx index 75c39114ac6..1070bb3d49c 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx index 77c952d2ac8..1d1aedf8e72 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx index 14cf0b6a6ed..2a596bf3564 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx index 8096f70c683..6c14b40de6c 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx index 94dbf346f8c..bb4c033a076 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx index 14d4b96590f..dcd41f568ed 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # 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: ```python diff --git a/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx index 7e9316070e3..c38da99a8d7 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx index 6da531bbf58..c8258f3c493 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # MemorySlot - + Memory slot channels represent classical memory storage. Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx index f9acc90d651..26e02e7a44a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.19/qiskit.pulse.PulseError.mdx index 617f7bfb1c6..027bf735dcb 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx index 2c484110432..2c925ed2379 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx index 749642ba878..d133fd8a9be 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SamplePulse # SamplePulse - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx index 4683401271e..5072d1c2afc 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Create an empty schedule. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx index 462c1f7edde..dc4c0818350 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # SetFrequency - + Set the channel frequency. This command operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx index 5a680d4ea47..332f8212b33 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx index 46247000c50..3b3191bea90 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx index 14cc9d23979..55110c51a26 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx @@ -32,7 +32,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -68,7 +68,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. Channel class. @@ -110,7 +110,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -146,7 +146,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -182,7 +182,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -218,7 +218,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -254,7 +254,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -290,7 +290,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -326,7 +326,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify commands for simulators. Create new snapshot channel. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx index b947e6ea3bd..f50c06682b9 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx index 38713ada8ee..ac54007617e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx index bf073c34fa8..ae54a1515cc 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx index 3a08b069358..18ac8524604 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx index 45dc9cfa8cb..b76292bf119 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Set the channel frequency. This command operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx index 4f9281b34bd..fc73be55ba3 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx index 14d1e439fe4..15201ae03a7 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.mdx b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.mdx index f543301eaa9..49d5faa1a3e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.pulse_lib.Constant # Constant - + A simple constant pulse, with an amplitude value and a duration: $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.mdx b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.mdx index 50a119731dc..516783270d0 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.pulse_lib.Drag # Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.mdx b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.mdx index 3027e099d8a..e75dbc57fca 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.pulse_lib.Gaussian # Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.mdx b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.mdx index 28c0abceeea..28f105b9c38 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.pulse_lib.GaussianSquare # GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.mdx b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.mdx index ccb57f895b0..353e04bfe2a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.pulse_lib.SamplePulse # SamplePulse - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx index e0d4bef0cff..bdd11572db8 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + A pygments lexer for OpenQasm. ## Attributes @@ -79,7 +79,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.19/qiskit.qasm.Qasm.mdx index 37ddad65849..22fbc777850 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.19/qiskit.qasm.QasmError.mdx index 0cc83aad9d6..1b8a063146d 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx index f54267f14b9..9c7fd034332 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx index edd7f3661f4..9e81cbb7575 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.mdx index a9a2bb8d89f..7c0a01cd951 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -22,7 +22,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.mdx index a2d15c44641..2246ca86e23 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + A Pulse Qobj. Instatiate a new Pulse Qobj Object. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.mdx index 80598b629a0..50bd7a427f9 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -32,7 +32,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.mdx index 6935de82344..8ba7f86bbbd 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.mdx index 85cf512b6cd..b26dcf55510 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.mdx index caff19d5ac5..33242f462dc 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.mdx index cae270d2b84..ada05644ceb 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + A QASM Qobj. Instatiate a new QASM Qobj Object. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.mdx index d3e58cfde97..53a4bb98a35 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.mdx index 6918e80b538..b64a2a942b9 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.mdx index d4da6ac3ca9..7aebfec3973 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. Instantiate a new Qobj dict field object. @@ -21,7 +21,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.mdx index cf78753109b..f7d50f3edb7 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instatiate a new QasmQobjInstruction object. @@ -32,7 +32,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.19/qiskit.qobj.Qobj.mdx index 0a3c63a0871..185ef9be137 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -17,7 +17,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.mdx index b63da57004c..e6aa5e7feb3 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -21,7 +21,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.mdx index dbe75ccb776..0519f93c795 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -21,7 +21,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.mdx index 70722b1958e..e4915e9ed21 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -22,7 +22,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.mdx index 3c3d19c4763..a8a560783ee 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -314,13 +314,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.mdx index 6ac356bec3e..6be26d3cfc4 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -322,13 +322,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.mdx index bc86dcce9c0..3ed037f2262 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -241,7 +241,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -263,13 +263,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -409,13 +409,13 @@ python_api_name: qiskit.quantum_info.Clifford ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.mdx index b60aef77eb8..3e08d554a3b 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -156,7 +156,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -180,7 +180,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -206,7 +206,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -465,13 +465,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.mdx index d7b14d40a8c..d99f98b8f14 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Kraus representation of a quantum channel. The Kraus representation for a quantum channel $\mathcal{E}$ is a set of matrices $[A_0,...,A_{K-1}]$ such that @@ -320,13 +320,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index aca8573ce77..d479b3bd0be 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ euler parameters are used. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.mdx index 7afddd80e9a..e001c2b755d 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -222,7 +222,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -340,13 +340,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.mdx index 0219724adfa..6eebdce72b7 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -322,13 +322,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.mdx index 18f4c26fa46..16f1b7d789b 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + A simple class representing Pauli Operators. The form is P\_zx = (-i)^dot(z,x) Z^z X^x where z and x are elements of Z\_2^n. That is, there are 4^n elements (no phases in this group). @@ -130,7 +130,7 @@ python_api_name: qiskit.quantum_info.Pauli ### from\_label - + Take pauli string to construct pauli. The qubit index of pauli label is q\_\{n-1} … q\_0. E.g., a pauli is \$P\_\{n-1} otimes … otimes P\_0\$ @@ -204,7 +204,7 @@ python_api_name: qiskit.quantum_info.Pauli ### pauli\_single - + Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -224,7 +224,7 @@ python_api_name: qiskit.quantum_info.Pauli ### random - + Return a random Pauli on number of qubits. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit.quantum_info.Pauli ### sgn\_prod - + Multiply two Paulis and track the phase. \$P\_3 = P\_1 otimes P\_2\$: X\*Y diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.mdx index b873c7c8f7a..ca81df8b8a7 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -430,7 +430,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -601,13 +601,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.mdx index fdd8a93a038..c533895a60a 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + A class representing a Quaternion. ## Methods @@ -25,7 +25,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.mdx index 82eabd28ef7..b2b1a78bd31 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](qiskit.quantum_info.ScalarOp#compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](qiskit.quantum_info.ScalarOp#dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](qiskit.quantum_info.ScalarOp#tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](qiskit.quantum_info.ScalarOp#expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -275,13 +275,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.mdx index f78f5bffeef..d119ea93457 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -213,13 +213,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this contruction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -386,13 +386,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.mdx index 639bbd3f4e2..42fc6d7c7fe 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -475,7 +475,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -658,13 +658,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.mdx index 51b929a867f..2accbe0586c 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Statevector class Initialize a statevector object. @@ -176,7 +176,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -226,7 +226,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -485,13 +485,13 @@ python_api_name: qiskit.quantum_info.Statevector ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.mdx index e6cf7c30f66..36bf78fa845 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -320,13 +320,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.mdx index 2d4367762a4..d2c5d1abb1d 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -314,13 +314,13 @@ $$ ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index df7c4988a86..651d90743be 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. ## Methods @@ -21,7 +21,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.19/qiskit.result.Result.mdx b/docs/api/qiskit/0.19/qiskit.result.Result.mdx index 9d70816a483..581f8a127b7 100644 --- a/docs/api/qiskit/0.19/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.19/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Model for Results. Please note that this class only describes the required fields. For the full description of the model, please check `ResultSchema`. @@ -125,7 +125,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Deserialize a dict of simple types into an instance of this class. Note that this method requires that the model is bound with `@bind_schema`. diff --git a/docs/api/qiskit/0.19/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.19/qiskit.result.ResultError.mdx index d8afb32421a..042313d9159 100644 --- a/docs/api/qiskit/0.19/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.19/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.mdx index fe2afc4535f..4ac12751546 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.mdx b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.mdx index 78c7d6f8b43..6a3bcfe7454 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.mdx +++ b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.mdx @@ -26,7 +26,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat ### CircuitPulseDef - + Create new instance of CircuitPulseDef(schedule, qubits) #### count diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.mdx index 970fde58213..8b2386ed825 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -103,25 +103,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.mdx index c60b40423b1..2455ce326ed 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.mdx index efa140e524f..c0d5ceb9736 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx index 5f83ec0dfee..7cf8f9a83d4 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.Layout.mdx index f9fc7b0f6ea..2c6a90de0bb 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -119,7 +119,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -164,7 +164,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers in regs. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.mdx index 7e6f37c9d2a..dd538563408 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.mdx index 29d52bbcfe6..cb94ead75bc 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.mdx index 39742e14c44..d8f9ec74b77 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + A default dictionary-like object ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.mdx index b1d4d0e9617..648da9917db 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.mdx index ce867accee2..067a24908db 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.mdx index 98c78f00009..29694a91e4c 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index eab5b8a2f4d..e6629f8534a 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.mdx index 741291fada0..8dc74daaa0e 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.mdx index aafc60c62f5..f65b6ea263e 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.mdx index 3face38f56b..0c51f50e8e0 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Cancel back-to-back cx gates in dag. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.mdx index e2cb3571b7b..fc435a13024 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Rearrange the direction of the cx nodes to match the directed coupling map. Flip the cx nodes to match the directed coupling map. This pass makes use of the following equivalence: diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.mdx index 4e278be5c9d..7b190f20e19 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Check if the CNOTs follow the right direction with respect to the coupling map. This pass checks if the CNOTs (or any other 2Q) in the DAG follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.mdx index d26ff65a758..533a5312798 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.mdx index f9d1df2ec5f..54cbead3091 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to propert\_set as a dictionary of the form: diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.mdx index f9b2350725c..1de3d887ac4 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.mdx index 1301b545f51..4e5e9183361 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.mdx index bea2d458678..424592fb3ca 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.mdx index 19553aa643a..8511e7d3927 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 77a1463cbad..709e74133c1 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 8554ae81c3a..80fead2f4fe 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.mdx index e1cd070c72d..b1b7ccf63de 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.mdx index 065c2a3963b..5e5ec5ed0e1 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.mdx index 7c4e4327317..22bd2538a91 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.mdx index d85ec111f25..afa25ab95d3 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.mdx index a9b43454671..c432aeef882 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Calculate the depth of a DAG circuit. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 5fb0080c86f..78915fac406 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.mdx index 0c75462c97d..33ac89b9dd8 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 2b505592e77..0d1f946c8fb 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.mdx index b0221285596..6d43e3f1781 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.mdx index 4fd5e8759e4..1a931d92144 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index b6e14a180d7..9196c9b41f9 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 95fbf4c80fa..b179229a7ae 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.mdx index 29200c5b4bc..55358ae8491 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.mdx index 97535978008..a20acb177d8 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -39,7 +39,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 40ca1f3daca..5fac977a5f6 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index ad1f717c98c..3120d0cc7a4 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index e3d08f7a8cc..4aaec1b4ce5 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.mdx index 621e6bdade2..ca307acb4bb 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.mdx index e7ec802dca3..5768cced1eb 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.mdx index 53eb21f79bc..682a944e55d 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.mdx index beddd69b68b..5de42204b8e 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 70a8e3f97bf..35904316448 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.mdx index 533121bb472..bfb82afc7f7 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.mdx index bf8a51fd837..f63d9729915 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. diff --git a/docs/api/qiskit/0.19/qiskit.validation.BaseModel.mdx b/docs/api/qiskit/0.19/qiskit.validation.BaseModel.mdx index 03b504ad24d..72225c0b97d 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.BaseModel.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.BaseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.BaseModel # BaseModel - + Base class for Models for validated Qiskit classes. BaseModel initializer. @@ -21,7 +21,7 @@ python_api_name: qiskit.validation.BaseModel ### from\_dict - + Deserialize a dict of simple types into an instance of this class. Note that this method requires that the model is bound with `@bind_schema`. diff --git a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx index 4b589969fea..e3c18dfbea3 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.BaseSchema # BaseSchema - + Base class for Schemas for validated Qiskit classes. Provides convenience functionality for the Qiskit common use case: @@ -130,7 +130,7 @@ python_api_name: qiskit.validation.BaseSchema ### from\_dict - + Generate a Schema class given a dictionary of fields. ```python diff --git a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx index bd1bcfb4eec..b31508a421a 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.ModelTypeValidator # ModelTypeValidator - + A field able to validate the correct type of a value. ## Attributes diff --git a/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.mdx b/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.mdx index 598dcc1c897..61b711457d5 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.ModelValidationError # ModelValidationError - + Raised when a sequence subscript is out of range. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.mdx index 33d5b5e1212..fcb77915340 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.mdx b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.mdx index 10d98098dc6..7bb01b9c264 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.mdx +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.mdx @@ -19,7 +19,7 @@ Style sheets for pulse visualization. ### PulseStyle - + Style sheet for Qiskit-Pulse sample pulse drawer. Create new style sheet. @@ -36,7 +36,7 @@ Style sheets for pulse visualization. ### SchedStyle - + Style sheet for Qiskit-Pulse schedule drawer. Create new style sheet. diff --git a/docs/api/qiskit/0.24/logging.mdx b/docs/api/qiskit/0.24/logging.mdx index a70ab6be1d1..a25e8f4d29c 100644 --- a/docs/api/qiskit/0.24/logging.mdx +++ b/docs/api/qiskit/0.24/logging.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.24/qiskit.aqua.AquaError.mdx index dbee48e6dce..0d11b6b648d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.AquaError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.mdx index ad5ad4555aa..2864bb27f69 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx index 235275d2a23..15393df4b59 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance # qiskit.aqua.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -168,19 +168,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -209,19 +209,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,31 +241,31 @@ python_api_name: qiskit.aqua.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. ### run\_config - + Getter of run\_config. @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index 3729bed074b..83655b6c64b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # qiskit.aqua.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -93,7 +93,7 @@ $$ ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -111,7 +111,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -163,7 +163,7 @@ $$ ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -179,7 +179,7 @@ $$ ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -221,7 +221,7 @@ $$ ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -253,7 +253,7 @@ $$ ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -275,7 +275,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -285,7 +285,7 @@ $$ ### random - + Return a numpy random. @@ -324,7 +324,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index c59fe42c546..0094cd85e0b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult - + AmplitudeEstimationAlgorithm Result. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### a\_estimation - + return a\_estimation **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### estimation - + return estimation **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index cfa8a48fd37..04a73202eef 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # qiskit.aqua.algorithms.AmplitudeEstimationResult - + AmplitudeEstimation Result. ### \_\_init\_\_ @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_samples - + return a\_samples **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### circuit\_result - + return circuit result **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_a\_samples - + return mapped\_a\_samples **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_values - + return mapped\_values **Return type** @@ -173,7 +173,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### max\_probability - + return max\_probability **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### ml\_value - + returns ml\_value **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mle - + return mle **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### probabilities - + return probabilities **Return type** @@ -247,7 +247,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### shots - + return shots **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### y\_measurements - + return y\_measurements **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.mdx index da54d40c5da..0579d9fe915 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # qiskit.aqua.algorithms.BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index ec9f567016a..c3fccd27123 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # qiskit.aqua.algorithms.ClassicalAlgorithm - + Base class for Classical Algorithms. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index d7d87081e41..75152535751 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # qiskit.aqua.algorithms.ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### random - + Return a numpy random. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### solution - + return solution diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.mdx index f270ce97a12..1d36b6b805d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # qiskit.aqua.algorithms.DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.mdx index e278f2163a3..84b1bcb6588 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # qiskit.aqua.algorithms.EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.mdx index ffd7e6ce7cc..75206accd32 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # qiskit.aqua.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### operator - + Return the operator. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.mdx index 006a5fc5a41..4bb0d1b935f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # qiskit.aqua.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.mdx index 70e8b22b09c..00a35dc7648 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # qiskit.aqua.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -147,7 +147,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -176,7 +176,7 @@ $$ ### grover\_operator - + Returns grover\_operator. **Return type** @@ -204,7 +204,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -241,7 +241,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -251,7 +251,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.mdx index 4b91477fe85..79f13427815 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # qiskit.aqua.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### assignment - + return assignment **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### circuit - + return circuit **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### measurement - + returns measurement **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### oracle\_evaluation - + return oracle evaluation **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### top\_measurement - + return top measurement **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.mdx index e840185c2e8..4a242803e8d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # qiskit.aqua.algorithms.HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -96,7 +96,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -124,7 +124,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -143,7 +143,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -162,7 +162,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** @@ -185,7 +185,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -195,7 +195,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.mdx index 21be9fd469e..66db89275af 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # qiskit.aqua.algorithms.HHLResult - + HHL Result. ### \_\_init\_\_ @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### circuit\_info - + return circuit info **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### matrix - + return matrix **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### output - + return output **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### probability\_result - + return probability result **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### solution - + return solution **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### vector - + return vector **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.mdx index 04f31198d72..ea43144606c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # qiskit.aqua.algorithms.IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It takes has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### random - + Return a numpy random. @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index 1b8135a058f..17aad153e24 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # qiskit.aqua.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -168,7 +168,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -242,7 +242,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -256,7 +256,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -278,7 +278,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -288,7 +288,7 @@ $$ ### random - + Return a numpy random. @@ -327,7 +327,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index 8cf838bb310..915263bd8c6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult - + IterativeAmplitudeEstimation Result. ### \_\_init\_\_ @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_intervals - + return a\_intervals **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### actual\_epsilon - + return mle **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### alpha - + return alpha **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### powers - + return powers **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### ratios - + return ratios **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + return theta\_intervals **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### value\_confidence\_interval - + return value\_confidence\_interval **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.mdx index b38102847b2..5606b27fe04 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # qiskit.aqua.algorithms.LinearsolverResult - + Linear solver Result. ### \_\_init\_\_ @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 771ec0512df..0b5bfde25db 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -83,7 +83,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -213,7 +213,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -267,7 +267,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -277,7 +277,7 @@ $$ ### random - + Return a numpy random. @@ -316,7 +316,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 5a8dea4512d..d3f38d2d0af 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + MaximumLikelihoodAmplitudeEstimation Result. ### \_\_init\_\_ @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### a\_estimation - + return a\_estimation **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### circuit\_results - + return circuit results **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### confidence\_interval - + return confidence\_interval **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### estimation - + return estimation **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fisher\_information - + return fisher\_information **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### theta - + returns theta **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 20e2cdd36d6..57368cba851 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # qiskit.aqua.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 993a0b1e35e..4703fc36337 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # qiskit.aqua.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.mdx index ea4a6b5363f..e13476c3aef 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # qiskit.aqua.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + Return the operator. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### random - + Return a numpy random. @@ -137,7 +137,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 3d76f7e83ce..ec380d237aa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # qiskit.aqua.algorithms.NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 2264d7852d6..e3e79b936dc 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # qiskit.aqua.algorithms.NumPyLSsolverResult - + Numpy LinearSystem Result. ### \_\_init\_\_ @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### eigvals - + return eigvals **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index d8fcb4656ec..b5cdea956ee 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # qiskit.aqua.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### random - + Return a numpy random. @@ -118,7 +118,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.mdx index 0ac54e38e74..fcd1fb67822 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # qiskit.aqua.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### random - + Return a numpy random. @@ -361,13 +361,13 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -383,7 +383,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.mdx index 44338a7560f..e26562373bb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # qiskit.aqua.algorithms.QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### d\_loss - + Returns discriminator loss **Return type** @@ -114,13 +114,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### discriminator - + Returns discriminator ### g\_loss - + Returns generator loss **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### generator - + Returns generator @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** @@ -156,13 +156,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### random - + Return a numpy random. ### rel\_entr - + Returns relative entropy between target and trained distribution **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### seed - + Returns random seed @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### tol\_rel\_ent - + Returns tolerance for relative entropy diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.mdx index 460246867c7..4bf391f683e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # qiskit.aqua.algorithms.QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### random - + Return a numpy random. @@ -182,7 +182,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.mdx index 6a9de70be16..b6490a241e0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # qiskit.aqua.algorithms.QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### backend - + Returns backend. **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index d48116ab98d..a12e4c6aabb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # qiskit.aqua.algorithms.QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.mdx index d33c4ec5848..c9f0182686a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # qiskit.aqua.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.mdx index 93ed26b18fe..3d6a4a08a9b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # qiskit.aqua.algorithms.Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.mdx index 04ae96d3b88..226dc3cf1c6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # qiskit.aqua.algorithms.SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). @@ -74,13 +74,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### class\_to\_label - + returns class to label ### label\_to\_class - + returns label to class @@ -114,13 +114,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.mdx index cc898e11d59..648d078a8f1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # qiskit.aqua.algorithms.VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### class\_to\_label - + returns class to label @@ -161,13 +161,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### datapoints - + return data points ### feature\_map - + Return the feature map. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### label\_to\_class - + returns label to class @@ -261,13 +261,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -308,13 +308,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### random - + Return a numpy random. ### ret - + returns result @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### test\_dataset - + returns test dataset @@ -400,13 +400,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### training\_dataset - + returns training dataset ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.mdx index 4546142dcb2..5292df1faa2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # qiskit.aqua.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### random - + Return a numpy random. @@ -361,13 +361,13 @@ python_api_name: qiskit.aqua.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -383,7 +383,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.mdx index 61f266bc5f5..9d512b532f5 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF # qiskit.aqua.circuits.CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.circuits.CNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.CNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.mdx index 76ec4dc5f95..e4dd0395092 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF # qiskit.aqua.circuits.DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.circuits.DNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.DNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.mdx index dc03fb11651..3af4ab315b3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # qiskit.aqua.circuits.ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.circuits.ESOP ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -107,25 +107,25 @@ python_api_name: qiskit.aqua.circuits.ESOP ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index f6edbb83318..744ccad2573 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # qiskit.aqua.circuits.PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** @@ -74,13 +74,13 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### ancillary\_register - + returns ancillary register ### auxiliary\_register - + returns auxiliary register @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### state\_register - + returns state register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.mdx index 6f253566945..5a0b716ea58 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # qiskit.aqua.circuits.StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.mdx index 4a202c5370c..e37f8695795 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # qiskit.aqua.circuits.WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -163,31 +163,31 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits ### num\_carry\_qubits - + returns num carry qubits ### num\_state\_qubits - + returns num state qubits ### num\_sum\_qubits - + returns num sum qubits ### num\_target\_qubits - + Returns the number of target qubits @@ -205,7 +205,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### weights - + returns weights diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.mdx index b22b853ec21..597dca0d1f5 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # qiskit.aqua.components.eigs.Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.mdx index e52fe56fe6f..0976db39a90 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # qiskit.aqua.components.eigs.EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 937ba2bf45a..d37f88ecda7 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # qiskit.aqua.components.feature\_maps.FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -60,31 +60,31 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index f02264ea06d..0b997c37b0d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # qiskit.aqua.components.feature\_maps.RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -71,31 +71,31 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.mdx index 0aa45691674..f8ae1e4190e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # qiskit.aqua.components.initial\_states.Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.mdx index 861ec2fa926..96c3ea998f6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # qiskit.aqua.components.initial\_states.InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,11 +36,11 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### bitstr - + ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.mdx index 0e7b2f5c925..c010311c335 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # qiskit.aqua.components.initial\_states.VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.mdx index 0727f84d3f8..74bac5078c9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # qiskit.aqua.components.initial\_states.Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry @@ -42,7 +42,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 3e6dec29247..24ffa4479aa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # qiskit.aqua.components.multiclass\_extensions.AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 65bc8b9f299..926bad9f755 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # qiskit.aqua.components.multiclass\_extensions.ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 6851d991bdd..2aafaef1957 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # qiskit.aqua.components.multiclass\_extensions.MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index 09478037a3b..e2ed5b748cc 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # qiskit.aqua.components.multiclass\_extensions.OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index 2e9ff9d4f90..538a74c13a0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # qiskit.aqua.components.neural\_networks.DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 88962c4dd6e..7a5da7b0f73 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # qiskit.aqua.components.neural\_networks.GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -53,13 +53,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_seed - + Set seed. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index e1a77d22b9b..97cca0e629b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # qiskit.aqua.components.neural\_networks.NumPyDiscriminator - + Discriminator based on NumPy **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 1ac2b6fbb84..21b8f8aa48a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # qiskit.aqua.components.neural\_networks.PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index 83252a46ec3..f8bb897802a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # qiskit.aqua.components.neural\_networks.QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.mdx index f12f96efa79..e6842ef2630 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # qiskit.aqua.components.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -124,67 +124,67 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -294,13 +294,13 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.mdx index d6dfd126688..ec0e3a2294a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # qiskit.aqua.components.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -132,67 +132,67 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -250,13 +250,13 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.mdx index 3bbe3d7fb3a..dc8f69c410b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # qiskit.aqua.components.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.mdx index 30d10604a82..ebc695ca3e1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # qiskit.aqua.components.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.mdx index 34da6d12a5f..502e2731578 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # qiskit.aqua.components.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.mdx index f43cbebbf2c..ced3a5ded3a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # qiskit.aqua.components.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.mdx index ad64507fdb5..456bc1e6ff3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # qiskit.aqua.components.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 677a220cfc5..98c5f0c58fe 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # qiskit.aqua.components.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.mdx index a71891add0c..669fc0bf6da 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # qiskit.aqua.components.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,67 +116,67 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -230,13 +230,13 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.mdx index 5d689df8adc..8666be8ecc9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # qiskit.aqua.components.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -150,67 +150,67 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -342,13 +342,13 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.mdx index 1b38b794060..0104c42ba3a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # qiskit.aqua.components.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.mdx index ebd13cc3c81..62ceaa1c693 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # qiskit.aqua.components.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index ab42e47be88..61c34a4697c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # qiskit.aqua.components.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index 5f4bab09dd6..657bb9123c1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # qiskit.aqua.components.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.mdx index 49071dc5d2c..6af9aab5c25 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # qiskit.aqua.components.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -123,67 +123,67 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -237,13 +237,13 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.mdx index 7d62a7860cd..7a4fdef0e2f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # qiskit.aqua.components.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -54,19 +54,19 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -87,73 +87,73 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -201,13 +201,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 3893ae7752c..685aa85e061 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # qiskit.aqua.components.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.mdx index 641039530f7..28f89f395f9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # qiskit.aqua.components.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.mdx index 89d34299a8b..413da6a8963 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # qiskit.aqua.components.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.mdx index c0f8aeda478..c20e8adaa8e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # qiskit.aqua.components.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.mdx index fd872f89d63..448f22185aa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # qiskit.aqua.components.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,67 +109,67 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -205,13 +205,13 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.mdx index 02da1b89a92..18334e434fa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # qiskit.aqua.components.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -125,67 +125,67 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -239,13 +239,13 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.mdx index fe3692c0080..56d0136b155 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # qiskit.aqua.components.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,67 +109,67 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -223,13 +223,13 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index e5c39666dae..1bf2e43446d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # qiskit.aqua.components.oracles.CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -95,13 +95,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 05d4f48d1dd..e2487629642 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # qiskit.aqua.components.oracles.LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -82,13 +82,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -104,13 +104,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.mdx index 4bfdeeae89f..383d464e447 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # qiskit.aqua.components.oracles.Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -22,7 +22,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -44,17 +44,17 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit - + Construct the oracle circuit. **Returns** @@ -64,13 +64,13 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.mdx index 83af8d54923..d8f7e018619 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # qiskit.aqua.components.oracles.TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: @@ -70,13 +70,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -92,13 +92,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.mdx index f694d120c38..b7bce5a65c4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # qiskit.aqua.components.reciprocals.LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.mdx index 3a889c57923..1e8ca9747e3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # qiskit.aqua.components.reciprocals.LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 8003ba970c1..a7c38295480 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # qiskit.aqua.components.reciprocals.Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 7c14552dc7a..684e8de0f2c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # qiskit.aqua.components.uncertainty\_models.BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -144,35 +144,35 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### p - + ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### probabilities - + returns probabilities @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 105b6c552ba..09e2977143a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # qiskit.aqua.components.uncertainty\_models.GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### dimension - + returns dimensions @@ -160,49 +160,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -220,7 +220,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index fda066cac74..8d6cd32aac8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # qiskit.aqua.components.uncertainty\_models.LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -147,31 +147,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### probabilities - + returns probabilities @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index a99d4d965a5..0e6a749bfbb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # qiskit.aqua.components.uncertainty\_models.MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 4e9ff2cebe7..f06f918c1ef 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # qiskit.aqua.components.uncertainty\_models.MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### dimension - + returns dimensions @@ -154,49 +154,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 99cdcf822fc..3de7522a963 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # qiskit.aqua.components.uncertainty\_models.MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### dimension - + returns dimensions @@ -156,49 +156,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -216,7 +216,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index a3481dd3775..c16d54da278 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index cb10bd7d3b6..615b6370780 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # qiskit.aqua.components.uncertainty\_models.MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### dimension - + returns dimensions @@ -155,49 +155,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -225,7 +225,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 88fc5d74f12..0e1ca89653e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # qiskit.aqua.components.uncertainty\_models.NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -147,31 +147,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### probabilities - + returns probabilities @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index e0192b9fa2d..32272428598 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # qiskit.aqua.components.uncertainty\_models.UncertaintyModel - + The abstract Uncertainty Model ### \_\_init\_\_ @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index 740d276552e..cf2d5735869 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # qiskit.aqua.components.uncertainty\_models.UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -143,31 +143,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### probabilities - + returns probabilities @@ -206,7 +206,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index a2b5ecdfa99..0f79f910390 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # qiskit.aqua.components.uncertainty\_models.UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -151,31 +151,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -196,7 +196,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### probabilities - + returns probabilities @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 59b6e5db3c9..b28cbf5e9ac 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # qiskit.aqua.components.uncertainty\_models.UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -146,31 +146,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### probabilities - + returns probabilities @@ -219,7 +219,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### values - + returns values diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index f92fa766e5c..08219e65ab6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # qiskit.aqua.components.uncertainty\_problems.MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index dde19680124..1e1ad2f07fd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # qiskit.aqua.components.uncertainty\_problems.UncertaintyProblem - + The abstract Uncertainty Problem component. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 881674a2aa8..3c7a6c94c05 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # qiskit.aqua.components.uncertainty\_problems.UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: @@ -158,7 +158,7 @@ $$ ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index a6a0f8e628e..f6f450d1716 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # qiskit.aqua.components.uncertainty\_problems.UnivariateProblem - + Univariate uncertainty problem. Constructor. @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 191ddb0daf8..b7094cefc06 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # qiskit.aqua.components.variational\_forms.VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -62,13 +62,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### parameter\_bounds - + Parameter bounds. **Returns** @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -118,11 +118,11 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.mdx index 125c5061c3e..2e78afbb35d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # qiskit.aqua.operators.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -224,13 +224,13 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -252,7 +252,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -270,7 +270,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -294,7 +294,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -316,7 +316,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -334,7 +334,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -354,7 +354,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.mdx index e26ed2bf6c8..8696cc7df2a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # qiskit.aqua.operators.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -55,7 +55,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.mdx index 8e65322a555..f9ed282fc68 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # qiskit.aqua.operators.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.mdx index 482e96c047e..58ea9dc95ef 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # qiskit.aqua.operators.converters.ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 8cf91402ae3..44a8240f7dd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # qiskit.aqua.operators.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.mdx index cba68d88295..cd0299ca642 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # qiskit.aqua.operators.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index f2fab603247..2646400fbfd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # qiskit.aqua.operators.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index 37fbf5d6d7d..fef54197418 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # qiskit.aqua.operators.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 302c9334051..abaae630cab 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # qiskit.aqua.operators.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -319,7 +319,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 8597b9199f3..29effb6ff47 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # qiskit.aqua.operators.evolutions.MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 5b00681eb06..f1c3cf68fb6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # qiskit.aqua.operators.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.mdx index 23187de5d57..49cef81128e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # qiskit.aqua.operators.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.mdx index 7a9d7399082..5326b61bb24 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # qiskit.aqua.operators.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.mdx index 31cfe304266..96d2b78b875 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # qiskit.aqua.operators.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index c2266e16d91..f6675b9a414 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # qiskit.aqua.operators.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 021309a5992..12d76b654cb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # qiskit.aqua.operators.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index bf1b920f212..264727e7480 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # qiskit.aqua.operators.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index 61d28b2d85c..0eefa93304a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # qiskit.aqua.operators.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 27df0d6fcaa..0d9d0af4dcd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # qiskit.aqua.operators.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index e6af382f847..92e6ba69db0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # qiskit.aqua.operators.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index 4d5b5e611a8..164c526af47 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # qiskit.aqua.operators.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.mdx index cb1a5a6d9d6..4cf1aeeb099 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # qiskit.aqua.operators.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.mdx index 7bf5cbd02c9..fbe4fb5f666 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # qiskit.aqua.operators.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 7a2bc121be5..43c6d4eb3e1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # qiskit.aqua.operators.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.mdx index 0708b6b1821..0504a846b41 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # qiskit.aqua.operators.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.mdx index ce61cdb17da..63e4a990129 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # qiskit.aqua.operators.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.mdx index 165a04bcf50..71bb1f1b782 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # qiskit.aqua.operators.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.mdx index a4700e85155..9fc308c16b9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # qiskit.aqua.operators.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.mdx index db63ef1b0ce..fd29a5adbec 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # qiskit.aqua.operators.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.mdx index 41f0f7540a6..f95017fba29 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # qiskit.aqua.operators.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -148,7 +148,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.mdx index 981d7b80abb..934d2ddd3eb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # qiskit.aqua.operators.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parametrized quantum state, where QFI is: @@ -95,7 +95,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -114,7 +114,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.mdx index 19b25feb67e..2723d31fb53 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # qiskit.aqua.operators.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parametrized quantum state. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index f75e82ff04c..556cb541f2f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -10,14 +10,14 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # qiskit.aqua.operators.legacy.LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. ### \_\_init\_\_ - + Constructor. @@ -45,65 +45,65 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### basis - + returns basis ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### name - + returns name ### num\_qubits - + Returns number of qubits for operator ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.mdx index f058b1b6205..8be01c70f2b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # qiskit.aqua.operators.legacy.MatrixOperator - + Operators relevant for quantum applications @@ -73,13 +73,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### atol - + return atol ### basis - + returns basis @@ -133,13 +133,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### dense\_matrix - + Getter of matrix in dense matrix form. ### dia\_matrix - + diagonal matrix @@ -231,19 +231,19 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### matrix - + Getter of matrix. ### name - + returns name ### num\_qubits - + number of qubits required for the operator. **Returns** @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.mdx index 2ba3cbf1d1b..13a0fce1d2d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # qiskit.aqua.operators.legacy.PauliGraph - + Pauli Graph. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph ### grouped\_paulis - + Getter of grouped Pauli list. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index f5fb8e27f31..b6f54784819 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -110,13 +110,13 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -316,7 +316,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -370,7 +370,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -394,7 +394,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### grouping\_func - + returns grouping function @@ -414,7 +414,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### kwargs - + returns kwargs @@ -440,19 +440,19 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### name - + returns name ### num\_groups - + returns number of groups ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -466,7 +466,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### paulis - + get paulis @@ -541,7 +541,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -609,7 +609,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** @@ -627,7 +627,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 55c1fe9bbed..06d5856c2f3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # qiskit.aqua.operators.legacy.WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -101,13 +101,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -307,7 +307,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -342,7 +342,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -361,7 +361,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -417,13 +417,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### name - + returns name ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -437,7 +437,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### paulis - + get paulis @@ -561,7 +561,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index 3a3bf7264ca..db3a62418de 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # qiskit.aqua.operators.legacy.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. **Returns** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -141,19 +141,19 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -184,13 +184,13 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### tapering\_values - + returns tapering values ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 6e2cc9acb62..5769011f41a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # qiskit.aqua.operators.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -367,7 +367,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.mdx index 90872d11297..296715cae2d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # qiskit.aqua.operators.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -285,7 +285,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -365,7 +365,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.mdx index bd3785022d7..57757136e91 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # qiskit.aqua.operators.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -360,7 +360,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -374,7 +374,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.mdx index 60aa4f6f1a1..d08b50038ec 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # qiskit.aqua.operators.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -324,7 +324,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index 6135ddf5e96..316d86efd31 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # qiskit.aqua.operators.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -325,7 +325,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index e611761a6cd..d486234a2e4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # qiskit.aqua.operators.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -329,7 +329,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index fdf66df89dd..1ccf4375cfd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # qiskit.aqua.operators.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -301,7 +301,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 736df0ceaa2..f98fa302253 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # qiskit.aqua.operators.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -275,7 +275,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -321,7 +321,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index 57ce740e30b..112e4bd94f7 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # qiskit.aqua.operators.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index be40b6269e7..4ef6511e865 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # qiskit.aqua.operators.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -232,7 +232,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -348,7 +348,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.mdx index 589b0d33658..ac13f92f7ec 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # qiskit.aqua.operators.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -267,7 +267,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -309,7 +309,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 63cfab8fe89..362e0638ecf 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # qiskit.aqua.operators.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.mdx index e86ff44ace8..0aa0fe39113 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # qiskit.aqua.operators.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -207,7 +207,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index c1aa68bcfc1..312626d49db 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # qiskit.aqua.operators.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -301,7 +301,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.mdx index 7a884c63178..cdfaa49f4f4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # qiskit.aqua.utils.CircuitFactory - + Base class for CircuitFactories ### \_\_init\_\_ @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.mdx index b86ff9dce7a..eb28dd3e342 100644 --- a/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig # qiskit.assembler.RunConfig - + Class for Run Configuration. ### shots @@ -99,7 +99,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.mdx index 95c3b604b27..52b224fd48f 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # qiskit.chemistry.BosonicOperator - + A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.mdx index 513e09fc230..4d7010d4eab 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # qiskit.chemistry.FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: @@ -129,13 +129,13 @@ python_api_name: qiskit.chemistry.FermionicOperator ### h1 - + Getter of one body integral tensor. ### h2 - + Getter of two body integral tensor. @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.FermionicOperator ### modes - + Getter of modes. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.mdx index 8b23707a2a2..db2ba832883 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info # qiskit.chemistry.MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_delta - + Get the MP2 delta energy correction for the molecule **Returns** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_energy - + Get the MP2 energy for the molecule **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.mdx index c651e1267ab..06c920f369a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule # qiskit.chemistry.QMolecule - + Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.QMolecule ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.QMolecule ### filename - + returns temp file path @@ -98,13 +98,13 @@ python_api_name: qiskit.chemistry.QMolecule ### one\_body\_integrals - + Returns one body electron integrals. ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -126,7 +126,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -159,13 +159,13 @@ python_api_name: qiskit.chemistry.QMolecule ### two\_body\_integrals - + Returns two body electron integrals. ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -188,7 +188,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -209,23 +209,23 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ### x\_dipole\_integrals - + returns x\_dipole\_integrals ### y\_dipole\_integrals - + returns y\_dipole\_integrals ### z\_dipole\_integrals - + returns z\_dipole\_integrals diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.mdx index e82edfac08f..b145a072958 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.mdx index 78af42d4512..115e378f1b8 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # qiskit.chemistry.WatsonHamiltonian - + Watson Hamiltonian class containing the results of a driver’s anharmonic calculation **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### data - + Returns the matrix elements of the Hamiltonian **Return type** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### num\_modes - + Returns the number of modes **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.mdx index b1b36342fc8..64ab1573e65 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # qiskit.chemistry.algorithms.AdaptVQE - + A ground state calculation employing the AdaptVQE algorithm. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.mdx index dcef4e98e71..a7d791861ac 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # qiskit.chemistry.algorithms.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 751a12a9267..be396f57da2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # qiskit.chemistry.algorithms.EigensolverFactory - + A factory to construct a eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index 45cbd433a80..91b180db605 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # qiskit.chemistry.algorithms.ExcitedStatesEigensolver - + The calculation of excited states via an Eigensolver algorithm **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 35a3f0006a1..a33ab684b75 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # qiskit.chemistry.algorithms.ExcitedStatesSolver - + The excited states calculation interface ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index b148cf26bb2..3aa11428894 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # qiskit.chemistry.algorithms.GroundStateEigensolver - + Ground state computation using a minimum eigensolver. **Parameters** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.mdx index 90a17e490e3..b6b783c1ba8 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # qiskit.chemistry.algorithms.GroundStateSolver - + The ground state calculation interface **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index 110bf3c6f78..fa3e2d095b8 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # qiskit.chemistry.algorithms.MinimumEigensolverFactory - + A factory to construct a minimum eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -29,7 +29,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index 7477125eefe..2694ada07aa 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # qiskit.chemistry.algorithms.NumPyEigensolverFactory - + A factory to construct a NumPyEigensolver. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### k - + returns k (number of eigenvalues requested) **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index 094b1dd7653..88091a40512 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory - + A factory to construct a NumPyMinimumEigensolver. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index be05436a532..92c34c5efe9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # qiskit.chemistry.algorithms.OrbitalOptimizationVQE - + A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.mdx index e098fe1e74a..12063b07034 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # qiskit.chemistry.algorithms.QEOM - + The calculation of excited states via the qEOM algorithm **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM ### excitations - + Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.mdx index 4208a9427c1..932f80f6b69 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # qiskit.chemistry.algorithms.QEomEE - + QEomEE algorithm (classical) **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### random - + Return a numpy random. @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.mdx index 57087697b52..f52777b8413 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # qiskit.chemistry.algorithms.QEomVQE - + QEomVQE algorithm **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -300,7 +300,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -324,7 +324,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -334,7 +334,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### random - + Return a numpy random. @@ -373,13 +373,13 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -395,7 +395,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.mdx index 591bc4d5279..6e0300fd348 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # qiskit.chemistry.algorithms.VQEAdapt - + DEPRECATED. The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -168,13 +168,13 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### random - + Return a numpy random. @@ -233,7 +233,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index f91bcf2a52c..7865e84d9d6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # qiskit.chemistry.algorithms.VQEUCCSDFactory - + A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### excitation\_type - + Getter of the `excitation_type` setting for the `excitation_type` setting. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_doubles - + Getter of the `method_doubles` setting for the `method_doubles` setting. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_singles - + Getter of the `method_singles` setting for the `method_singles` setting. **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### same\_spin\_doubles - + Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index eba9ef1e791..ba1b95e5414 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # qiskit.chemistry.algorithms.VQEUVCCSDFactory - + A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 7e9bdf78983..503bb7be54d 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # qiskit.chemistry.algorithms.pes\_samplers.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index ce4f0e530cf..9ded214fbac 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # qiskit.chemistry.algorithms.pes\_samplers.DifferentialExtrapolator - + An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. Constructor. @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index ef7c9d980b0..10d68b16a88 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # qiskit.chemistry.algorithms.pes\_samplers.EnergySurface1DSpline - + A simple cubic spline interpolation for the potential energy surface. A spline interpolation method for data fitting. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 2cb5db46a73..8626c490ef2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # qiskit.chemistry.algorithms.pes\_samplers.EnergySurfaceBase - + Class to hold a potential energy surface ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 39f99c0601b..6a6ef24c8b9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # qiskit.chemistry.algorithms.pes\_samplers.Extrapolator - + This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. Each instance of an Extrapolator requires a dictionary where each item consist of a point (key) and a list of variational parameters (value) for that given point. In practice, a Sampler Class can utilize the Extrapolator as a wrapper. The Extrapolator class then extracts optimal variational parameters from the previous points for use in extrapolation. For instance, one can utilize the Extrapolator to accelerate the computation of the Born-Oppenheimer Potential Energy Surface (BOPES) for a given molecule. In this case, each point can represent the interatomic distance and the list of parameters represent rotational parameters in a quantum circuit, in the context of computing the bond dissociation profile for a diatomic molecule. NOTE: However this is not a requirement - once an instance of the Extrapolator class is created, extrapolation can proceed by specifying the point(s) of interest and the dictionary of (point, parameter) pairs for a problem. @@ -33,7 +33,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index a17b1eee13d..ccd21a7756c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # qiskit.chemistry.algorithms.pes\_samplers.HarmonicPotential - + Implements a 1D Harmonic potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -110,7 +110,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + **Mostly for internal use. Preprocesses the data passed to fit\_to\_data()** so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index c11b9374a2c..37f9ad9bbae 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # qiskit.chemistry.algorithms.pes\_samplers.MorsePotential - + Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 0ffcdcdc4ce..22f6ae942d4 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PCAExtrapolator - + A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. Constructor. @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index 7a8908ab650..a2c5bca0d86 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PolynomialExtrapolator - + An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 0d67e4572dc..08be80e3191 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # qiskit.chemistry.algorithms.pes\_samplers.PotentialBase - + Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index ac28aca2cf9..6b18064a531 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.SieveExtrapolator - + A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. Constructor. @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index 46ea22f4cda..62e7d73301f 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # qiskit.chemistry.algorithms.pes\_samplers.VibronicStructureBase - + Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index fcb72b4f32f..eb16303d020 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.WindowExtrapolator - + An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. Constructor. @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### extrapolator - + Returns the internal extrapolator. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### window - + Returns the size of the window. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index 4e1de82bf8f..d548c1b5b8c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # qiskit.chemistry.applications.MolecularGroundStateEnergy - + Molecular ground state energy chemistry application **Parameters** @@ -78,7 +78,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### driver - + Returns chemistry driver **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### solver - + Returns minimum eigen solver **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 4db47e76b64..51881d879d6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # qiskit.chemistry.components.bosonic\_bases.BosonicBasis - + Basis to express a second quantization Bosonic Hamiltonian. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 6f1ae747013..0c86fc02eec 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # qiskit.chemistry.components.bosonic\_bases.HarmonicBasis - + Basis in which the Watson Hamiltonian is expressed. This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) as a modal basis for the expression of the Watson Hamiltonian or any bosonic operator. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 70fec3422cd..d8f60b5f525 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # qiskit.chemistry.components.initial\_states.HartreeFock - + A Hartree-Fock initial state. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.mdx index 16500190342..995e9b46f77 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # qiskit.chemistry.components.initial\_states.VSCF - + Initial state for vibrational modes. Creates an occupation number vector as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. e.g. for 2 modes with 4 modals per mode it creates: |1000 1000> @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF ### bitstr - + Getter of the bit string represented the statevector. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.mdx index a550182fe58..73e864c3201 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # qiskit.chemistry.components.variational\_forms.CHC - + This trial wavefunction is the Compact Heuristic for Chemistry. The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. It aims at approximating the UCC Ansatz for a lower CNOT count. @@ -88,13 +88,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -136,7 +136,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -144,11 +144,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -162,7 +162,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.mdx index fb7fcdb032a..3b817e28ff4 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # qiskit.chemistry.components.variational\_forms.UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -139,7 +139,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -169,7 +169,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -211,13 +211,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### double\_excitations - + Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] ### excitation\_pool - + Returns the full list of available excitations (called the pool). **Return type** @@ -227,13 +227,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -252,7 +252,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -277,7 +277,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -291,7 +291,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -305,7 +305,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -324,7 +324,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### parameter\_bounds - + Parameter bounds. **Returns** @@ -344,7 +344,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -360,7 +360,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -384,17 +384,17 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### setting - + ### single\_excitations - + Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -408,7 +408,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.mdx index 298a76adf0b..07ffc36656e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # qiskit.chemistry.components.variational\_forms.UVCC - + This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -128,13 +128,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -162,7 +162,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -184,11 +184,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -202,7 +202,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.mdx index 97a119fe652..e449c3fbf1e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.mdx @@ -10,12 +10,12 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # qiskit.chemistry.core.ChemistryOperator - + Base class for ChemistryOperator. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -39,7 +39,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### molecule\_info - + returns molecule info @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.mdx index 73ec783f6c0..5c821a10a0c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # qiskit.chemistry.core.Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### molecule\_info - + returns molecule info diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.mdx index 2276d04139c..c1043396841 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # qiskit.chemistry.core.MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 3d67caec145..a8882c22670 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # qiskit.chemistry.core.MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.mdx index fcd5fcbe3ac..c1c492cd918 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # qiskit.chemistry.core.MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -173,7 +173,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -207,7 +207,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -241,7 +241,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -335,7 +335,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -345,7 +345,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -355,7 +355,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -365,7 +365,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.mdx index f55e25c8489..600563002e5 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # qiskit.chemistry.core.QubitMappingType - + QubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.mdx index 7c56819b413..67c00b21c2d 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # qiskit.chemistry.core.TransformationType - + Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.mdx index 36413e91d19..33085aa9907 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # qiskit.chemistry.drivers.BaseDriver - + Base class for Qiskit’s chemistry drivers. **Parameters** @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### basis - + return basis **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### molecule - + return molecule **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.mdx index a1ffbc531d5..8b41dac2c51 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # qiskit.chemistry.drivers.BasisType - + Basis Type ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.mdx index 39d694de1e3..604c6c22176 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # qiskit.chemistry.drivers.BosonicDriver - + Base class for Qiskit’s chemistry bosonic drivers. **Parameters** @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### molecule - + return molecule **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 839f5165033..955f58d314f 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # qiskit.chemistry.drivers.FCIDumpDriver - + Qiskit chemistry driver reading an FCIDump file. The FCIDump format is partially defined in Knowles1989. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### basis - + return basis **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### molecule - + return molecule **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.mdx index be15ec23257..c35005c34bb 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # qiskit.chemistry.drivers.FermionicDriver - + Base class for Qiskit’s chemistry fermionic drivers. **Parameters** @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### molecule - + return molecule **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.mdx index a3292a3e8d8..53232fedec6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # qiskit.chemistry.drivers.GaussianDriver - + Qiskit chemistry driver using the Gaussian™ 16 program. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### basis - + return basis **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### molecule - + return molecule **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index 9a93f273874..78dad45ba1e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # qiskit.chemistry.drivers.GaussianForcesDriver - + Gaussian™ 16 forces driver. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 6ddd1e68433..6fece6650b2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # qiskit.chemistry.drivers.GaussianLogDriver - + Gaussian™ 16 log driver. Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### molecule - + return molecule **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.mdx index 618141eb810..34bb7e614a9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # qiskit.chemistry.drivers.GaussianLogResult - + Result for Gaussian™ 16 log driver. This result allows access to selected data from the log file that is not available via the use Gaussian 16 interfacing code when using the MatrixElement file. Since this parses the text output it is subject to the format of the log file. @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### a\_to\_h\_numbering - + A to H numbering mapping. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### cubic\_force\_constants - + Cubic force constants. (3 indices, 3 values) **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### log - + The complete Gaussian log in the form of a list of strings. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quadratic\_force\_constants - + Quadratic force constants. (2 indices, 3 values) **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quartic\_force\_constants - + Quartic force constants. (4 indices, 3 values) **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.mdx index 3cca17b86a2..db8244ec110 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # qiskit.chemistry.drivers.HDF5Driver - + Qiskit chemistry driver reading an HDF5 file. The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. @@ -46,7 +46,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### basis - + return basis **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### molecule - + return molecule **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### work\_path - + Returns work path. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.mdx index 5485a909b4e..95ea2c1a4d6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # qiskit.chemistry.drivers.HFMethodType - + HFMethodType Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.mdx index e5c315ce09c..9db05c9eab1 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # qiskit.chemistry.drivers.InitialGuess - + Initial Guess Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.mdx index d93cdf550ce..0ba78336efb 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # qiskit.chemistry.drivers.Molecule - + Driver-independent Molecule definition. This module implements an interface for a driver-independent, i.e. generic molecule definition. It defines the composing atoms (with properties like masses), and allows for changing the molecular geometry through given degrees of freedom (e.g. bond-stretching, angle-bending, etc.). The geometry as provided in the constructor can be affected, through setting perturbations, and it is this perturbed geometry that is supplied by the geometry getter. Setting perturbations to None will cause the original geometry to be returned, and there is a getter to get this value directly if its needed. @@ -68,7 +68,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -140,7 +140,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### charge - + Get charge **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### geometry - + Get geometry accounting for any perturbations **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### masses - + Get masses **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### multiplicity - + Get multiplicity **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### perturbations - + Get perturbations **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -208,7 +208,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) @@ -226,7 +226,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### units - + The geometry coordinate units diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.mdx index d57387cc74b..82830aee7f0 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # qiskit.chemistry.drivers.PSI4Driver - + Qiskit chemistry driver using the PSI4 program. See [http://www.psicode.org/](http://www.psicode.org/) @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.mdx index 126935554a9..94b85d3963f 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # qiskit.chemistry.drivers.PyQuanteDriver - + Qiskit chemistry driver using the PyQuante2 library. See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante2) @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### basis - + return basis **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### molecule - + return molecule **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.mdx index 1d136af99d4..e812b7fae35 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # qiskit.chemistry.drivers.PySCFDriver - + Qiskit chemistry driver using the PySCF library. See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### basis - + return basis **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### molecule - + return molecule **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.mdx index c6b3bd10811..b9f6e3ce6d3 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # qiskit.chemistry.drivers.UnitsType - + Units Type Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.mdx index 05f5db4e6b9..247a8ca87f8 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # qiskit.chemistry.results.BOPESSamplerResult - + The BOPES Sampler result Creates an new instance of the result. :type points: `List`\[`float`] :param points: List of points. :type energies: `List`\[`float`] :param energies: List of energies. :type raw\_results: `Dict`\[`float`, `EigenstateResult`] :param raw\_results: Raw results obtained from the solver. @@ -38,7 +38,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### energies - + returns list of energies. **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### points - + returns list of points. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### raw\_results - + returns all results for all points. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.mdx index cd478ba82d0..556e71bae0a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # qiskit.chemistry.results.EigenstateResult - + The eigenstate result interface. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenenergies - + returns eigen energies **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenstates - + returns eigen states **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundenergy - + returns ground energy **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundstate - + returns ground state **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.mdx index 95aeb6b22df..a9d7ef8394a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # qiskit.chemistry.results.ElectronicStructureResult - + The electronic structure result. ### \_\_init\_\_ @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_energies - + Returns electronic part of ground state energy **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -220,7 +220,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundstate - + returns ground state **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### magnetization - + Returns measured magnetization **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### num\_particles - + Returns measured number of particles **Return type** @@ -314,7 +314,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -324,7 +324,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -354,7 +354,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### spin - + Returns computed spin **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -408,7 +408,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** @@ -418,7 +418,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_energies - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.mdx index e970c054b2d..98a2676e557 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # qiskit.chemistry.results.VibronicStructureResult - + The vibronic structure result. ### \_\_init\_\_ @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### computed\_vibronic\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundstate - + returns ground state **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### num\_occupied\_modals\_per\_mode - + Returns the number of occupied modal per mode **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 7f992393879..f4c44ec4231 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # qiskit.chemistry.transformations.BosonicQubitMappingType - + BosonicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.mdx index 2eaccfcc0f8..dec43321687 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # qiskit.chemistry.transformations.BosonicTransformation - + A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### basis - + returns the basis (number of modals per mode) **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### num\_modes - + the number of modes **Type** @@ -149,7 +149,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.mdx index f1f58b041ad..032171fab48 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # qiskit.chemistry.transformations.BosonicTransformationType - + BosonicTransformationType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index 347898c4daf..9bdea3483d4 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # qiskit.chemistry.transformations.FermionicQubitMappingType - + FermionicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.mdx index b43eef515f7..d840f048216 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # qiskit.chemistry.transformations.FermionicTransformation - + A transformation from a fermionic problem, represented by a driver, to a qubit operator. **Parameters** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### molecule\_info - + Getter of the molecule information. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### qubit\_mapping - + Getter of the qubit mapping. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.mdx index b234eeaac02..5c6c7d67061 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # qiskit.chemistry.transformations.FermionicTransformationType - + Electronic Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.mdx index 2a49c8a7279..d46388ee0ef 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # qiskit.chemistry.transformations.Transformation - + Base class for transformation to qubit operators for chemistry problems ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.mdx index 2965637c3a3..25d28bed577 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit # qiskit.circuit.AncillaQubit - + A qubit used as ancillary qubit. Creates a qubit. @@ -54,13 +54,13 @@ python_api_name: qiskit.circuit.AncillaQubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.mdx index 70f98ff2019..7f9a79491a3 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister # qiskit.circuit.AncillaRegister - + Implement an ancilla register. Create a new generic register. @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### name - + Get the register name. @@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.mdx index 6bd63c81d54..bb4de4b23fd 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # qiskit.circuit.ClassicalRegister - + Implement a classical register. Create a new generic register. @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### name - + Get the register name. @@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Clbit.mdx index 22af6be0395..197e50570dd 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Clbit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit # qiskit.circuit.Clbit - + Implement a classical bit. Creates a classical bit. @@ -54,13 +54,13 @@ python_api_name: qiskit.circuit.Clbit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.mdx index 6432ebf6dd6..d408f7ad46f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate # qiskit.circuit.ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -324,13 +324,13 @@ python_api_name: qiskit.circuit.ControlledGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.ControlledGate ### duration - + Get the duration. @@ -362,7 +362,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return gate label **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.circuit.ControlledGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.ControlledGate ### params - + Get parameters from base\_gate. **Returns** @@ -504,7 +504,7 @@ python_api_name: qiskit.circuit.ControlledGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Delay.mdx index 0f49acfe774..bcd737a6828 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Delay.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay # qiskit.circuit.Delay - + Do nothing and just delay/wait/idle for a specified duration. Create new delay instruction. @@ -109,19 +109,19 @@ python_api_name: qiskit.circuit.Delay ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration of this delay. @@ -155,7 +155,7 @@ python_api_name: qiskit.circuit.Delay ### params - + return instruction params. @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.Delay ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.mdx index 534404906f8..11fd5998e79 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # qiskit.circuit.EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Gate.mdx index 77dbc6c1d2a..3b8f5209573 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate # qiskit.circuit.Gate - + Unitary gate. Create a new gate. @@ -188,19 +188,19 @@ python_api_name: qiskit.circuit.Gate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -234,7 +234,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return gate label **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.Gate ### params - + return instruction params. @@ -350,7 +350,7 @@ python_api_name: qiskit.circuit.Gate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Instruction.mdx index 92c90edbec2..c774964f2dc 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Instruction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction # qiskit.circuit.Instruction - + Generic quantum instruction. Create a new instruction. @@ -134,19 +134,19 @@ python_api_name: qiskit.circuit.Instruction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.Instruction ### params - + return instruction params. @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.Instruction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.mdx index 42d20534c7f..6d45cedfb77 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet # qiskit.circuit.InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Measure.mdx index 606b6344fb0..30a0e4eaf34 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Measure.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure # qiskit.circuit.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.Measure ### params - + return instruction params. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Parameter.mdx index e03d96565dc..7f8c93f887d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Parameter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter # qiskit.circuit.Parameter - + Parameter Class for variable parameters. Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). @@ -105,13 +105,13 @@ python_api_name: qiskit.circuit.Parameter ### name - + Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.mdx index f75cb6753dc..94e37ed20c9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression # qiskit.circuit.ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). @@ -110,7 +110,7 @@ python_api_name: qiskit.circuit.ParameterExpression ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.mdx index ccadc295d3f..75162f38c0a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector # qiskit.circuit.ParameterVector - + ParameterVector class to quickly generate lists of parameters. ### \_\_init\_\_ @@ -35,13 +35,13 @@ python_api_name: qiskit.circuit.ParameterVector ### name - + Returns the name of the ParameterVector. ### params - + Returns the list of parameters in the ParameterVector. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.mdx index b6144de5683..4090035c800 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # qiskit.circuit.QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ python_api_name: qiskit.circuit.QuantumCircuit ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### data - + Return the circuit data (instructions and context). **Returns** @@ -1013,7 +1013,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1031,7 +1031,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1049,7 +1049,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### global\_phase - + Return the global phase of the circuit in radians. @@ -1380,13 +1380,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1418,13 +1418,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1452,7 +1452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1592,7 +1592,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.mdx index 992ac2a6eab..295a2e0815b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister # qiskit.circuit.QuantumRegister - + Implement a quantum register. Create a new generic register. @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### name - + Get the register name. @@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Qubit.mdx index 292b06eb600..95c96d36e10 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Qubit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit # qiskit.circuit.Qubit - + Implement a quantum bit. Creates a qubit. @@ -54,13 +54,13 @@ python_api_name: qiskit.circuit.Qubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.24/qiskit.circuit.Reset.mdx index 554d57d4f56..2a64f610d00 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.Reset.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset # qiskit.circuit.Reset - + Qubit reset. Create new reset instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.Reset ### params - + return instruction params. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 4eb38f321c0..380ee7972cb 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # qiskit.circuit.classicalfunction.ClassicalFunction - + Represent a classical function function and its logic network. Creates a `ClassicalFunction` from Python source code in `source`. @@ -93,7 +93,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### args - + Returns the classicalfunction arguments @@ -218,19 +218,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### label - + Return gate label **Return type** @@ -290,13 +290,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### network - + Returns the logical network ### params - + return instruction params. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### qregs - + The list of qregs used by the classicalfunction @@ -378,7 +378,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### scopes - + Returns the scope dict @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### types - + Dumps a list of scopes with their variables and types. **Returns** @@ -438,7 +438,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index ca7892a8974..7b6e97104f5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index ef5f3cc0f05..c63a8cd6188 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.AND.mdx index e2b7ae90991..69ed34d45dd 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.AND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND # qiskit.circuit.library.AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -211,7 +211,7 @@ python_api_name: qiskit.circuit.library.AND ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.AND ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -378,19 +378,19 @@ python_api_name: qiskit.circuit.library.AND ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -608,7 +608,7 @@ python_api_name: qiskit.circuit.library.AND ### data - + Return the circuit data (instructions and context). **Returns** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -968,7 +968,7 @@ python_api_name: qiskit.circuit.library.AND ### global\_phase - + Return the global phase of the circuit in radians. @@ -1299,13 +1299,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1337,13 +1337,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1371,7 +1371,7 @@ python_api_name: qiskit.circuit.library.AND ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1511,7 +1511,7 @@ python_api_name: qiskit.circuit.library.AND ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.mdx index 7f575efca2c..71095ace93c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier # qiskit.circuit.library.Barrier - + Barrier instruction. Create new barrier instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Barrier ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.library.Barrier ### params - + return instruction params. @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.library.Barrier ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.mdx index ebd60fe0ada..7ed3a984d38 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # qiskit.circuit.library.C3SXGate - + The 3-qubit controlled sqrt-X gate. This implementation is based on Page 17 of \[1]. @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -204,13 +204,13 @@ python_api_name: qiskit.circuit.library.C3SXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### params - + Get parameters from base\_gate. **Returns** @@ -380,7 +380,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.mdx index b83399ab6d9..b8bc009718b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate # qiskit.circuit.library.C3XGate - + The 4-qubit controlled X gate. This implementation uses $\sqrt{T}$ and 14 CNOT gates. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.C3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### duration - + Get the duration. @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return gate label **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### params - + Get parameters from base\_gate. **Returns** @@ -360,7 +360,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.mdx index 3dbddc691e1..075b39b5ac9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate # qiskit.circuit.library.C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1]. @@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -188,13 +188,13 @@ python_api_name: qiskit.circuit.library.C4XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### params - + Get parameters from base\_gate. **Returns** @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.mdx index 0b0c39bf2c8..8558f65b306 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate # qiskit.circuit.library.CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** @@ -228,7 +228,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -238,13 +238,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -254,7 +254,7 @@ $$ ### duration - + Get the duration. @@ -272,7 +272,7 @@ $$ ### label - + Return gate label **Return type** @@ -298,7 +298,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -312,7 +312,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -406,7 +406,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.mdx index 54af2f08749..ce7e10cce55 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate # qiskit.circuit.library.CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. @@ -223,7 +223,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -233,13 +233,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -249,7 +249,7 @@ $$ ### duration - + Get the duration. @@ -267,7 +267,7 @@ $$ ### label - + Return gate label **Return type** @@ -293,7 +293,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -307,7 +307,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -401,7 +401,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.mdx index ea011c30959..71834ff5a7c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # qiskit.circuit.library.CPhaseGate - + Controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -283,7 +283,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.mdx index 95e8846bca3..cb185e69f7d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate # qiskit.circuit.library.CRXGate - + Controlled-RX gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -304,7 +304,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -398,7 +398,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.mdx index 1dd5a41d311..fcb3c68fee4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate # qiskit.circuit.library.CRYGate - + Controlled-RY gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -304,7 +304,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -398,7 +398,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.mdx index a3c82a1532c..a74d1de41bf 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate # qiskit.circuit.library.CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -226,7 +226,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -236,13 +236,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -252,7 +252,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -310,7 +310,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -404,7 +404,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.mdx index 4c5ab3ac8dd..9aee91408e9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate # qiskit.circuit.library.CSXGate - + Controlled-√X gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -268,7 +268,7 @@ $$ ### label - + Return gate label **Return type** @@ -294,7 +294,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -308,7 +308,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -402,7 +402,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.mdx index 5029c45a00c..27b8df9c6a7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # qiskit.circuit.library.CSwapGate - + Controlled-X gate. **Circuit symbol:** @@ -239,7 +239,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -249,13 +249,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -265,7 +265,7 @@ $$ ### duration - + Get the duration. @@ -283,7 +283,7 @@ $$ ### label - + Return gate label **Return type** @@ -309,7 +309,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -323,7 +323,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -417,7 +417,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.mdx index 64a2eee2a9c..1be63290c4e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # qiskit.circuit.library.CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -283,7 +283,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.mdx index 19c747bb91c..79884d44ed7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # qiskit.circuit.library.CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -310,7 +310,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -404,7 +404,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.mdx index 00e38624521..9deca132903 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate # qiskit.circuit.library.CUGate - + Controlled-U gate (4-parameter two-qubit gate). This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $e^{i\gamma}$ of the U gate. @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -310,7 +310,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -404,7 +404,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.mdx index 16278d94796..e416785bfd0 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate # qiskit.circuit.library.CXGate - + Controlled-X gate. **Circuit symbol:** @@ -222,7 +222,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -232,13 +232,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -248,7 +248,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return gate label **Return type** @@ -292,7 +292,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -306,7 +306,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -400,7 +400,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.mdx index 46b2102ee2f..40d5e450846 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate # qiskit.circuit.library.CYGate - + Controlled-Y gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -304,7 +304,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -398,7 +398,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.mdx index fcffa4e01f9..b75b5a5829b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate # qiskit.circuit.library.CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. @@ -201,7 +201,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -211,13 +211,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -227,7 +227,7 @@ $$ ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -285,7 +285,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.mdx index 15bc70428be..79538514134 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate # qiskit.circuit.library.DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -242,7 +242,7 @@ $$ ### label - + Return gate label **Return type** @@ -268,7 +268,7 @@ $$ ### params - + return instruction params. @@ -350,7 +350,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.mdx index 68a538a7e99..5e8d0ef24cc 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal # qiskit.circuit.library.Diagonal - + Diagonal circuit. Circuit symbol: @@ -245,7 +245,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -366,7 +366,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -376,7 +376,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -412,19 +412,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -642,7 +642,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -966,7 +966,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -984,7 +984,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1002,7 +1002,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,13 +1333,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1371,13 +1371,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1405,7 +1405,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1545,7 +1545,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.mdx index a17df7013a9..46da342350a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # qiskit.circuit.library.EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -387,7 +387,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -433,19 +433,19 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -663,7 +663,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + Return the circuit data (instructions and context). **Returns** @@ -955,7 +955,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -969,7 +969,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -1015,7 +1015,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1033,7 +1033,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1075,7 +1075,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### global\_phase - + Return the global phase of the circuit in radians. @@ -1123,7 +1123,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1143,7 +1143,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1434,13 +1434,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1464,7 +1464,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1486,13 +1486,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1512,7 +1512,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1542,7 +1542,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1592,7 +1592,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1700,7 +1700,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qregs - + A list of the quantum registers associated with the circuit. @@ -1774,7 +1774,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1836,7 +1836,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1942,7 +1942,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.mdx index 51dabff8134..be15f00d43f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # qiskit.circuit.library.ExcitationPreserving - + The heurisitic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -328,7 +328,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -410,7 +410,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -420,7 +420,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -456,19 +456,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -686,7 +686,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -978,7 +978,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -992,7 +992,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -1038,7 +1038,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1056,7 +1056,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1098,7 +1098,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1146,7 +1146,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1166,7 +1166,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1457,13 +1457,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1487,7 +1487,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1509,13 +1509,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1535,7 +1535,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1565,7 +1565,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1601,7 +1601,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1615,7 +1615,7 @@ $$ ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1654,7 +1654,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1723,7 +1723,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1797,7 +1797,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1859,7 +1859,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1965,7 +1965,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.mdx index a0ef979422c..f3d332968b7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # qiskit.circuit.library.FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -229,7 +229,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -350,7 +350,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -360,7 +360,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -396,19 +396,19 @@ python_api_name: qiskit.circuit.library.FourierChecking ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -626,7 +626,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### data - + Return the circuit data (instructions and context). **Returns** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -968,7 +968,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -986,7 +986,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### global\_phase - + Return the global phase of the circuit in radians. @@ -1317,13 +1317,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1355,13 +1355,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1389,7 +1389,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1529,7 +1529,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.mdx index 62e8e5b7f3a..f09f5d50d1d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # qiskit.circuit.library.FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -209,7 +209,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,7 +1313,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1327,13 +1327,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1365,19 +1365,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1413,7 +1413,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1485,7 +1485,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qregs - + A list of the quantum registers associated with the circuit. @@ -1559,7 +1559,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.mdx index 7dffb1c5eef..752ad95be2a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS # qiskit.circuit.library.GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -232,7 +232,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -353,7 +353,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -363,7 +363,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -399,19 +399,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -629,7 +629,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -953,7 +953,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -971,7 +971,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -989,7 +989,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1320,13 +1320,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1358,13 +1358,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1392,7 +1392,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1532,7 +1532,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GR.mdx index 9cc80341e2b..66fba21647f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GR.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR # qiskit.circuit.library.GR - + Global R gate. **Circuit symbol:** @@ -227,7 +227,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -348,7 +348,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -358,7 +358,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -394,19 +394,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -624,7 +624,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -948,7 +948,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -984,7 +984,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1315,13 +1315,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1353,13 +1353,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1387,7 +1387,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1527,7 +1527,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.mdx index 2bc97786619..a4ab188babe 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX # qiskit.circuit.library.GRX - + Global RX gate. **Circuit symbol:** @@ -225,7 +225,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -346,7 +346,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,13 +1313,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1351,13 +1351,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1385,7 +1385,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1525,7 +1525,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.mdx index 172515fb2f6..ee8192d6128 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY # qiskit.circuit.library.GRY - + Global RY gate. **Circuit symbol:** @@ -225,7 +225,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -346,7 +346,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,13 +1313,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1351,13 +1351,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1385,7 +1385,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1525,7 +1525,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.mdx index 07d5d492de2..15a930c38ee 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ # qiskit.circuit.library.GRZ - + Global RZ gate. **Circuit symbol:** @@ -225,7 +225,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -346,7 +346,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,13 +1313,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1351,13 +1351,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1385,7 +1385,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1525,7 +1525,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.mdx index 81cde10ce76..2d57eb240d1 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState # qiskit.circuit.library.GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -235,7 +235,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -356,7 +356,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -366,7 +366,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -402,19 +402,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -632,7 +632,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -956,7 +956,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1323,13 +1323,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1361,13 +1361,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1395,7 +1395,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1535,7 +1535,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.mdx index bf4b0e9a4f8..3bd675db093 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # qiskit.circuit.library.GroverOperator - + The Grover operator. Grover’s search algorithm \[1, 2] consists of repeated applications of the so-called Grover operator used to amplify the amplitudes of the desired output states. This operator, $\mathcal{Q}$, consists of the phase oracle, $\mathcal{S}_f$, zero phase-shift or zero reflection, $\mathcal{S}_0$, and an input state preparation $\mathcal{A}$: @@ -342,7 +342,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -463,7 +463,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -473,7 +473,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -509,19 +509,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -739,7 +739,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1063,7 +1063,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1081,7 +1081,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1099,7 +1099,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1430,13 +1430,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1468,13 +1468,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1496,7 +1496,7 @@ $$ ### oracle - + The oracle implementing a reflection about the bad state. @@ -1508,7 +1508,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1648,7 +1648,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1672,7 +1672,7 @@ $$ ### reflection\_qubits - + Reflection qubits, on which S0 is applied (if S0 is not user-specified). @@ -2047,7 +2047,7 @@ $$ ### state\_preparation - + The subcircuit implementing the A operator or Hadamards. **Return type** @@ -2297,7 +2297,7 @@ $$ ### zero\_reflection - + The subcircuit implementing the reflection about 0. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.mdx index cde3dcab85b..a3e10f9330f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate # qiskit.circuit.library.HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -330,7 +330,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.mdx index 7633c1cefd4..5b26adf6b3a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # qiskit.circuit.library.HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -237,7 +237,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -358,7 +358,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -368,7 +368,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -404,19 +404,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -634,7 +634,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -958,7 +958,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -976,7 +976,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -994,7 +994,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1325,13 +1325,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1363,13 +1363,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1397,7 +1397,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1537,7 +1537,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.mdx index b92c87e2396..388e360bee6 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate # qiskit.circuit.library.IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). @@ -193,19 +193,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ $$ ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ $$ ### params - + return instruction params. @@ -331,7 +331,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.mdx index d516dc19ebb..ef4cae1fff9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP # qiskit.circuit.library.IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.IQP ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.IQP ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ python_api_name: qiskit.circuit.library.IQP ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ python_api_name: qiskit.circuit.library.IQP ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ python_api_name: qiskit.circuit.library.IQP ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,13 +1313,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1351,13 +1351,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.IQP ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1525,7 +1525,7 @@ python_api_name: qiskit.circuit.library.IQP ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.mdx index c661dd47156..b3c1a98550a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # qiskit.circuit.library.InnerProduct - + An n\_qubit circuit that computes the inner product of two registers. Return a circuit to compute the inner product of 2 n-qubit registers. @@ -209,7 +209,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -330,7 +330,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -376,19 +376,19 @@ python_api_name: qiskit.circuit.library.InnerProduct ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -606,7 +606,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### data - + Return the circuit data (instructions and context). **Returns** @@ -930,7 +930,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### global\_phase - + Return the global phase of the circuit in radians. @@ -1297,13 +1297,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1335,13 +1335,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1369,7 +1369,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1509,7 +1509,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.mdx index c8d13256b5a..1455d48e3c8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # qiskit.circuit.library.IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on the parameter `geq`): @@ -220,7 +220,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -341,7 +341,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -351,7 +351,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -387,19 +387,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -617,7 +617,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -941,7 +941,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -959,7 +959,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -977,7 +977,7 @@ $$ ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -991,7 +991,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1322,19 +1322,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1366,19 +1366,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -1414,7 +1414,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1486,7 +1486,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1560,7 +1560,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2161,7 +2161,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 20d5e8cc05e..d07be096b53 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # qiskit.circuit.library.LinearAmplitudeFunction - + A circuit implementing a (piecewise) linear function on qubit amplitudes. An amplitude function $F$ of a function $f$ is a mapping @@ -255,7 +255,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -376,7 +376,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -386,7 +386,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -422,19 +422,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -652,7 +652,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -976,7 +976,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -994,7 +994,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1012,7 +1012,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1343,13 +1343,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1381,13 +1381,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1415,7 +1415,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1573,7 +1573,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.mdx index 0f769ae6b16..04dacfe65a4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # qiskit.circuit.library.LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -236,7 +236,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -332,7 +332,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -373,7 +373,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -383,7 +383,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -419,19 +419,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -649,7 +649,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -973,7 +973,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -991,7 +991,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1009,7 +1009,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1340,7 +1340,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1354,13 +1354,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1392,19 +1392,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1434,7 +1434,7 @@ $$ ### offset - + The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. @@ -1456,7 +1456,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1528,7 +1528,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1602,7 +1602,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1824,7 +1824,7 @@ $$ ### slope - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.mdx index 5315cadd1e8..9a089291802 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # qiskit.circuit.library.LogNormalDistribution - + A circuit to encode a discretized log-normal distribution in qubit amplitudes. A random variable $X$ is log-normal distributed if @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -375,7 +375,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -385,7 +385,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -395,7 +395,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -431,19 +431,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -661,7 +661,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -985,7 +985,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1003,7 +1003,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1021,7 +1021,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1352,13 +1352,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1390,13 +1390,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1424,7 +1424,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1455,7 +1455,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1574,7 +1574,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2175,7 +2175,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.mdx index c75bc387d42..7d5ee86b892 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT # qiskit.circuit.library.MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as: @@ -235,7 +235,7 @@ python_api_name: qiskit.circuit.library.MCMT ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.library.MCMT ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -366,7 +366,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -402,19 +402,19 @@ python_api_name: qiskit.circuit.library.MCMT ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -614,7 +614,7 @@ python_api_name: qiskit.circuit.library.MCMT ### data - + Return the circuit data (instructions and context). **Returns** @@ -938,7 +938,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.MCMT ### global\_phase - + Return the global phase of the circuit in radians. @@ -1265,19 +1265,19 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_ancilla\_qubits - + Return the number of ancillas. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1309,13 +1309,13 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1343,7 +1343,7 @@ python_api_name: qiskit.circuit.library.MCMT ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1483,7 +1483,7 @@ python_api_name: qiskit.circuit.library.MCMT ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.mdx index cfc3daa7d6c..4d23e7c19b7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # qiskit.circuit.library.MCMTVChain - + The MCMT implementation using the CCX V-chain. This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -378,7 +378,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -388,7 +388,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -424,19 +424,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -636,7 +636,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### data - + Return the circuit data (instructions and context). **Returns** @@ -960,7 +960,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -978,7 +978,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -996,7 +996,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### global\_phase - + Return the global phase of the circuit in radians. @@ -1287,19 +1287,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_ancilla\_qubits - + Return the number of ancilla qubits required. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1331,13 +1331,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1365,7 +1365,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1505,7 +1505,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.mdx index af274dfe984..9305cbb8188 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # qiskit.circuit.library.MCPhaseGate - + Multi-controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the state of the control qubits. @@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -201,13 +201,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### duration - + Get the duration. @@ -235,7 +235,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### label - + Return gate label **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### params - + Get parameters from base\_gate. **Returns** @@ -377,7 +377,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.mdx index 10a440b780f..f89b1bebe48 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate # qiskit.circuit.library.MCXGate - + The general, multi-controlled X gate. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### label - + Return gate label **Return type** @@ -252,13 +252,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### params - + Get parameters from base\_gate. **Returns** @@ -374,7 +374,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.mdx index 26cd157105f..7d512652c5c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # qiskit.circuit.library.MCXGrayCode - + Implement the multi-controlled X gate using the Gray code. This delegates the implementation to the MCU1 gate, since $X = H \cdot U1(\pi) \cdot H$. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -228,7 +228,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### label - + Return gate label **Return type** @@ -254,13 +254,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -274,7 +274,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### params - + Get parameters from base\_gate. **Returns** @@ -376,7 +376,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.mdx index 40b15a782a4..c382a916924 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # qiskit.circuit.library.MCXRecursive - + Implement the multi-controlled X gate using recursion. Using a single ancilla qubit, the multi-controlled X gate is recursively split onto four sub-registers. This is done until we reach the 3- or 4-controlled X gate since for these we have a concrete implementation that do not require ancillas. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### label - + Return gate label **Return type** @@ -252,13 +252,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### params - + Get parameters from base\_gate. **Returns** @@ -374,7 +374,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.mdx index 362f89101cf..040a05320e1 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # qiskit.circuit.library.MCXVChain - + Implement the multi-controlled X gate using a V-chain of CX gates. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### label - + Return gate label **Return type** @@ -250,13 +250,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -270,7 +270,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### params - + Get parameters from base\_gate. **Returns** @@ -372,7 +372,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.mdx index 51eb9f9b008..d4a3c179415 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate # qiskit.circuit.library.MSGate - + MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. Global Mølmer–Sørensen gate. @@ -180,19 +180,19 @@ python_api_name: qiskit.circuit.library.MSGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MSGate ### params - + return instruction params. @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.MSGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.mdx index ee5c5e89e5b..39525686764 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure # qiskit.circuit.library.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.Measure ### params - + return instruction params. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.mdx index ae0b53d46a9..e7214499548 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal # qiskit.circuit.library.NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -307,7 +307,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -389,7 +389,7 @@ python_api_name: qiskit.circuit.library.NLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -399,7 +399,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -435,19 +435,19 @@ python_api_name: qiskit.circuit.library.NLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -665,7 +665,7 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -957,7 +957,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -971,7 +971,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -1017,7 +1017,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1035,7 +1035,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1097,7 +1097,7 @@ python_api_name: qiskit.circuit.library.NLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1145,7 +1145,7 @@ python_api_name: qiskit.circuit.library.NLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1165,7 +1165,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1456,13 +1456,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1486,7 +1486,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1508,13 +1508,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1534,7 +1534,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1564,7 +1564,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1600,7 +1600,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1614,7 +1614,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1653,7 +1653,7 @@ python_api_name: qiskit.circuit.library.NLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1722,7 +1722,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1796,7 +1796,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1858,7 +1858,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1964,7 +1964,7 @@ python_api_name: qiskit.circuit.library.NLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.mdx index e1f9c79dbbe..f1437126794 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # qiskit.circuit.library.NormalDistribution - + A circuit to encode a discretized normal distribution in qubit amplitudes. The probability density function of the normal distribution is defined as @@ -302,7 +302,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -433,7 +433,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -443,7 +443,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -479,19 +479,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -709,7 +709,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1033,7 +1033,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1051,7 +1051,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1069,7 +1069,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1400,13 +1400,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1438,13 +1438,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1472,7 +1472,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1503,7 +1503,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1622,7 +1622,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2223,7 +2223,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.OR.mdx index c4fa6769c35..5a35c3f3dc8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.OR.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR # qiskit.circuit.library.OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -211,7 +211,7 @@ python_api_name: qiskit.circuit.library.OR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.OR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -378,19 +378,19 @@ python_api_name: qiskit.circuit.library.OR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -608,7 +608,7 @@ python_api_name: qiskit.circuit.library.OR ### data - + Return the circuit data (instructions and context). **Returns** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -968,7 +968,7 @@ python_api_name: qiskit.circuit.library.OR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1299,13 +1299,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1337,13 +1337,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1371,7 +1371,7 @@ python_api_name: qiskit.circuit.library.OR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1511,7 +1511,7 @@ python_api_name: qiskit.circuit.library.OR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.mdx index 84c63f0361a..29660ca541c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # qiskit.circuit.library.PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -334,7 +334,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -416,7 +416,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -426,7 +426,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -462,19 +462,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -692,7 +692,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -984,7 +984,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -998,7 +998,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -1034,7 +1034,7 @@ $$ ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -1054,7 +1054,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1072,7 +1072,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1134,7 +1134,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1182,7 +1182,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1202,7 +1202,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1493,13 +1493,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1523,7 +1523,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1545,19 +1545,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1587,7 +1587,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1623,7 +1623,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1637,7 +1637,7 @@ $$ ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1663,7 +1663,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1702,7 +1702,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1771,7 +1771,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1845,7 +1845,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1907,7 +1907,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2013,7 +2013,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.mdx index dd3196fe06b..b9faf868d31 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation # qiskit.circuit.library.Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.Permutation ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.Permutation ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -392,19 +392,19 @@ python_api_name: qiskit.circuit.library.Permutation ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -622,7 +622,7 @@ python_api_name: qiskit.circuit.library.Permutation ### data - + Return the circuit data (instructions and context). **Returns** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ python_api_name: qiskit.circuit.library.Permutation ### global\_phase - + Return the global phase of the circuit in radians. @@ -1313,13 +1313,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1351,13 +1351,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.Permutation ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1525,7 +1525,7 @@ python_api_name: qiskit.circuit.library.Permutation ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.mdx index 85b79ca8f6d..ad52f12f79a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # qiskit.circuit.library.PhaseEstimation - + Phase Estimation circuit. In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is @@ -237,7 +237,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -358,7 +358,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -368,7 +368,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -404,19 +404,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -634,7 +634,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -958,7 +958,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -976,7 +976,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -994,7 +994,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1325,13 +1325,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1363,13 +1363,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1397,7 +1397,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1537,7 +1537,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.mdx index 802cca5a057..90dbdc4b78c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # qiskit.circuit.library.PhaseGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -214,19 +214,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -244,7 +244,7 @@ $$ ### label - + Return gate label **Return type** @@ -270,7 +270,7 @@ $$ ### params - + return instruction params. @@ -352,7 +352,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 9ed1b6a41c4..bf131dbeb35 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # qiskit.circuit.library.PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -233,7 +233,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -329,7 +329,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -370,7 +370,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitely is `2**(num_state_qubits + 1)`. @@ -382,7 +382,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -392,7 +392,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -428,19 +428,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -530,7 +530,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -672,7 +672,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1014,7 +1014,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1032,7 +1032,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1050,7 +1050,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1208,7 +1208,7 @@ $$ ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -1222,7 +1222,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -1409,19 +1409,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1453,19 +1453,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1495,7 +1495,7 @@ $$ ### offsets - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitely is `2**(num_state_qubits + 1)`. @@ -1513,7 +1513,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1585,7 +1585,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1659,7 +1659,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1881,7 +1881,7 @@ $$ ### slopes - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitely is `2**(num_state_qubits + 1)`. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.mdx index 46fdbb6a879..7d48ac00f7e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # qiskit.circuit.library.PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -236,7 +236,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -332,7 +332,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -373,7 +373,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -383,7 +383,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -419,19 +419,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -443,7 +443,7 @@ $$ ### coeffs - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. @@ -665,7 +665,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -701,7 +701,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -1003,7 +1003,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1021,7 +1021,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1039,7 +1039,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1370,19 +1370,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1414,19 +1414,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1462,7 +1462,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1534,7 +1534,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1608,7 +1608,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1676,7 +1676,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.mdx index 75ee07e0944..8407ae2c1c6 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT # qiskit.circuit.library.QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -232,7 +232,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -263,7 +263,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -367,7 +367,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -377,7 +377,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -413,19 +413,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -643,7 +643,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -752,7 +752,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -981,7 +981,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1017,7 +1017,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1071,7 +1071,7 @@ $$ ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -1344,13 +1344,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1382,13 +1382,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -1428,7 +1428,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1500,7 +1500,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1574,7 +1574,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.mdx index 3c1be738c2a..67f0ddcff45 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # qiskit.circuit.library.QuadraticForm - + Implements a quadratic form on binary variables encoded in qubit registers. A quadratic form on binary variables is a quadratic function $Q$ acting on a binary variable of $n$ bits, $x = x_0 ... x_{n-1}$. For an integer matrix $A$, an integer vector $b$ and an integer $c$ the function can be written as @@ -242,7 +242,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -363,7 +363,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -373,7 +373,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -409,19 +409,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -639,7 +639,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -963,7 +963,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -981,7 +981,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1330,13 +1330,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1368,13 +1368,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1402,7 +1402,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1542,7 +1542,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1604,7 +1604,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.mdx index 53eba7bd7cc..0552ce4a9a8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # qiskit.circuit.library.QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -221,7 +221,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -352,7 +352,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -388,19 +388,19 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -618,7 +618,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### data - + Return the circuit data (instructions and context). **Returns** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -960,7 +960,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -978,7 +978,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### global\_phase - + Return the global phase of the circuit in radians. @@ -1309,13 +1309,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1347,13 +1347,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1381,7 +1381,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.mdx index 784940f8aa5..a17c7d1deba 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # qiskit.circuit.library.RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -178,19 +178,19 @@ python_api_name: qiskit.circuit.library.RC3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return gate label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### params - + return instruction params. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.mdx index 6c0b0f73b41..47235eae4eb 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # qiskit.circuit.library.RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -178,19 +178,19 @@ python_api_name: qiskit.circuit.library.RCCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return gate label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### params - + return instruction params. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.mdx index bb5e4aac193..050a7b864c2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate # qiskit.circuit.library.RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** @@ -188,19 +188,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -220,7 +220,7 @@ $$ ### label - + Return gate label **Return type** @@ -246,7 +246,7 @@ $$ ### params - + return instruction params. @@ -328,7 +328,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.mdx index 079ccfbbb51..726b0dfcd46 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate # qiskit.circuit.library.RXXGate - + A parameteric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -218,19 +218,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -248,7 +248,7 @@ $$ ### label - + Return gate label **Return type** @@ -274,7 +274,7 @@ $$ ### params - + return instruction params. @@ -356,7 +356,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.mdx index 9038c68b932..a818a5b36cb 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate # qiskit.circuit.library.RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** @@ -188,19 +188,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -220,7 +220,7 @@ $$ ### label - + Return gate label **Return type** @@ -246,7 +246,7 @@ $$ ### params - + return instruction params. @@ -328,7 +328,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.mdx index 8972b08a80d..cb10464de8d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate # qiskit.circuit.library.RYYGate - + A parameteric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -218,19 +218,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -248,7 +248,7 @@ $$ ### label - + Return gate label **Return type** @@ -274,7 +274,7 @@ $$ ### params - + return instruction params. @@ -356,7 +356,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.mdx index 75068da6f9b..584c1e9a932 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate # qiskit.circuit.library.RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -232,7 +232,7 @@ $$ ### label - + Return gate label **Return type** @@ -258,7 +258,7 @@ $$ ### params - + return instruction params. @@ -340,7 +340,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.mdx index 5ca4eda8152..0fbf63453b1 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate # qiskit.circuit.library.RZXGate - + A parameteric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. @@ -256,19 +256,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -286,7 +286,7 @@ $$ ### label - + Return gate label **Return type** @@ -312,7 +312,7 @@ $$ ### params - + return instruction params. @@ -394,7 +394,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.mdx index c3ec7c93d0c..513f6bc75f5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate # qiskit.circuit.library.RZZGate - + A parameteric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -230,19 +230,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -260,7 +260,7 @@ $$ ### label - + Return gate label **Return type** @@ -286,7 +286,7 @@ $$ ### params - + return instruction params. @@ -368,7 +368,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.mdx index 64300feabcf..879a65fd01a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # qiskit.circuit.library.RealAmplitudes - + The real-amplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. It is called `RealAmplitudes` since the prepared quantum states will only have real amplitudes, the complex part is always 0. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -414,7 +414,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -460,19 +460,19 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -690,7 +690,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + Return the circuit data (instructions and context). **Returns** @@ -982,7 +982,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -996,7 +996,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -1042,7 +1042,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1060,7 +1060,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1102,7 +1102,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### global\_phase - + Return the global phase of the circuit in radians. @@ -1150,7 +1150,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1170,7 +1170,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1461,13 +1461,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1491,7 +1491,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1513,13 +1513,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1539,7 +1539,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1569,7 +1569,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1619,7 +1619,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1658,7 +1658,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1727,7 +1727,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qregs - + A list of the quantum registers associated with the circuit. @@ -1801,7 +1801,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1863,7 +1863,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1969,7 +1969,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.mdx index 0cad6e1951c..4405fc482dd 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset # qiskit.circuit.library.Reset - + Qubit reset. Create new reset instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.Reset ### params - + return instruction params. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.mdx index fd368fcbd96..11fd0297892 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate # qiskit.circuit.library.SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). @@ -197,19 +197,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -227,7 +227,7 @@ $$ ### label - + Return gate label **Return type** @@ -253,7 +253,7 @@ $$ ### params - + return instruction params. @@ -335,7 +335,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.mdx index 975cb7305ba..27102a9e203 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate # qiskit.circuit.library.SXGate - + The single-qubit Sqrt(X) gate ($\sqrt{X}$). **Matrix Representation:** @@ -201,19 +201,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -231,7 +231,7 @@ $$ ### label - + Return gate label **Return type** @@ -257,7 +257,7 @@ $$ ### params - + return instruction params. @@ -339,7 +339,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.mdx index 2ca4f4d9414..e7f45450c0c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # qiskit.circuit.library.SXdgGate - + The inverse single-qubit Sqrt(X) gate. $$ @@ -193,19 +193,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ $$ ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ $$ ### params - + return instruction params. @@ -331,7 +331,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.mdx index eee4dbc07a8..3c33bd23d31 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate # qiskit.circuit.library.SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. @@ -197,19 +197,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -227,7 +227,7 @@ $$ ### label - + Return gate label **Return type** @@ -253,7 +253,7 @@ $$ ### params - + return instruction params. @@ -335,7 +335,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.mdx index 0252041e97f..b133e596d2e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate # qiskit.circuit.library.SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -230,7 +230,7 @@ $$ ### label - + Return gate label **Return type** @@ -256,7 +256,7 @@ $$ ### params - + return instruction params. @@ -338,7 +338,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.mdx index f0d72d64946..263db3e9f97 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate # qiskit.circuit.library.TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). @@ -197,19 +197,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -227,7 +227,7 @@ $$ ### label - + Return gate label **Return type** @@ -253,7 +253,7 @@ $$ ### params - + return instruction params. @@ -335,7 +335,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.mdx index aab78206252..27376785446 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate # qiskit.circuit.library.TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. @@ -197,19 +197,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -227,7 +227,7 @@ $$ ### label - + Return gate label **Return type** @@ -253,7 +253,7 @@ $$ ### params - + return instruction params. @@ -335,7 +335,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.mdx index 934c68b6fb2..05ffb49f912 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # qiskit.circuit.library.TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -354,7 +354,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -436,7 +436,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -446,7 +446,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -482,19 +482,19 @@ python_api_name: qiskit.circuit.library.TwoLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -712,7 +712,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -1004,7 +1004,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -1018,7 +1018,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -1064,7 +1064,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1082,7 +1082,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1124,7 +1124,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1172,7 +1172,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1192,7 +1192,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1483,13 +1483,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1513,7 +1513,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1535,13 +1535,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1561,7 +1561,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1591,7 +1591,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1627,7 +1627,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1641,7 +1641,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1680,7 +1680,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1749,7 +1749,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1823,7 +1823,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1885,7 +1885,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1991,7 +1991,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.mdx index ed87b7e4491..d1f8dc50afa 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate # qiskit.circuit.library.U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -216,19 +216,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -246,7 +246,7 @@ $$ ### label - + Return gate label **Return type** @@ -272,7 +272,7 @@ $$ ### params - + return instruction params. @@ -354,7 +354,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.mdx index a96fceb03d9..51b0d9ac944 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate # qiskit.circuit.library.U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: @@ -210,19 +210,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -242,7 +242,7 @@ $$ ### label - + Return gate label **Return type** @@ -268,7 +268,7 @@ $$ ### params - + return instruction params. @@ -350,7 +350,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.mdx index abb672ed7fb..102b0701d8d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate # qiskit.circuit.library.U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -345,7 +345,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.mdx index 62664b52547..ff9244531f5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate # qiskit.circuit.library.UGate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -345,7 +345,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.mdx index 3123aee682e..08e18f3237f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # qiskit.circuit.library.UniformDistribution - + A circuit to encode a discretized uniform distribution in qubit amplitudes. This simply corresponds to applying Hadamard gates on all qubits. @@ -227,7 +227,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -348,7 +348,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -358,7 +358,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -394,19 +394,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -624,7 +624,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -948,7 +948,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -984,7 +984,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1315,13 +1315,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1353,13 +1353,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1387,7 +1387,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1527,7 +1527,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.mdx index 80d5b86125d..9b22801a37c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # qiskit.circuit.library.WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -253,7 +253,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -374,7 +374,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -384,7 +384,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -420,19 +420,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -650,7 +650,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -974,7 +974,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1010,7 +1010,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1341,7 +1341,7 @@ $$ ### num\_ancilla\_qubits - + The number of ancilla qubits required to implement the weighted sum. **Return type** @@ -1355,13 +1355,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_carry\_qubits - + The number of carry qubits required to compute the sum. Note that this is not necessarily equal to the number of ancilla qubits, these can be queried using `num_ancilla_qubits`. @@ -1377,7 +1377,7 @@ $$ ### num\_clbits - + Return number of classical bits. @@ -1401,7 +1401,7 @@ $$ ### num\_control\_qubits - + The number of additional control qubits required. Note that the total number of ancilla qubits can be obtained by calling the method `num_ancilla_qubits`. @@ -1425,19 +1425,19 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -1451,7 +1451,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -1487,7 +1487,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1559,7 +1559,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1633,7 +1633,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2234,7 +2234,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.mdx index 6672c0b6c85..9998688c73b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate # qiskit.circuit.library.XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** @@ -210,19 +210,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -240,7 +240,7 @@ $$ ### label - + Return gate label **Return type** @@ -266,7 +266,7 @@ $$ ### params - + return instruction params. @@ -348,7 +348,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.mdx index f235e18e465..a2e6a505188 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR # qiskit.circuit.library.XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -221,7 +221,7 @@ python_api_name: qiskit.circuit.library.XOR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.XOR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -352,7 +352,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -388,19 +388,19 @@ python_api_name: qiskit.circuit.library.XOR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -618,7 +618,7 @@ python_api_name: qiskit.circuit.library.XOR ### data - + Return the circuit data (instructions and context). **Returns** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -960,7 +960,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -978,7 +978,7 @@ python_api_name: qiskit.circuit.library.XOR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1309,13 +1309,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1347,13 +1347,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1381,7 +1381,7 @@ python_api_name: qiskit.circuit.library.XOR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.XOR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.mdx index 220c39fd62f..40914ab3688 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate # qiskit.circuit.library.YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** @@ -210,19 +210,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -240,7 +240,7 @@ $$ ### label - + Return gate label **Return type** @@ -266,7 +266,7 @@ $$ ### params - + return instruction params. @@ -348,7 +348,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.mdx index f73fa5e3363..e65249feb54 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # qiskit.circuit.library.ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -386,7 +386,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -396,7 +396,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -432,19 +432,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -662,7 +662,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -968,7 +968,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -1004,7 +1004,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -1024,7 +1024,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1042,7 +1042,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1104,7 +1104,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1152,7 +1152,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1172,7 +1172,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1463,13 +1463,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1493,7 +1493,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1515,19 +1515,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1557,7 +1557,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1593,7 +1593,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1607,7 +1607,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1633,7 +1633,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1672,7 +1672,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1741,7 +1741,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1815,7 +1815,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1877,7 +1877,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1983,7 +1983,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.mdx index 92090fc03d4..ec0fc7f604b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate # qiskit.circuit.library.ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** @@ -210,19 +210,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -240,7 +240,7 @@ $$ ### label - + Return gate label **Return type** @@ -266,7 +266,7 @@ $$ ### params - + return instruction params. @@ -348,7 +348,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.mdx index 9bd43a13aec..d1c605f9540 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # qiskit.circuit.library.ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -374,7 +374,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -384,7 +384,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -420,19 +420,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -650,7 +650,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -992,7 +992,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -1012,7 +1012,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1030,7 +1030,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1092,7 +1092,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1140,7 +1140,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1160,7 +1160,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1451,13 +1451,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1503,19 +1503,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1545,7 +1545,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1581,7 +1581,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1621,7 +1621,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1660,7 +1660,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1729,7 +1729,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1803,7 +1803,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1865,7 +1865,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1971,7 +1971,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.mdx index 6acad10159e..48f2fc5b556 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # qiskit.circuit.library.iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. @@ -225,19 +225,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -271,7 +271,7 @@ $$ ### label - + Return gate label **Return type** @@ -297,7 +297,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.mdx index 5b73f43f2da..788229124ff 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # qiskit.dagcircuit.DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. @@ -172,7 +172,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -182,7 +182,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### clbits - + Return a list of classical bits (as a list of Clbit instances). @@ -315,7 +315,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** @@ -355,7 +355,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### global\_phase - + Return the global phase of the circuit. @@ -435,7 +435,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### node\_counter - + Returns the number of nodes in the dag. @@ -531,7 +531,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### qubits - + Return a list of qubits (as a list of Qubit instances). @@ -708,7 +708,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### wires - + Return a list of the wires in order. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.mdx index 2333fbb0a3b..f549d349e99 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.mdx index 9678bc0cfae..3a469480179 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # qiskit.dagcircuit.DAGDepNode - + Object to represent the information at a node in the DAGDependency(). It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -58,19 +58,19 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.mdx index 32e1285f9e8..4803139fb30 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # qiskit.dagcircuit.DAGDependency - + Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed. @@ -102,7 +102,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -281,7 +281,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### global\_phase - + Return the global phase of the circuit. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.mdx index 52e9be059d0..a266fecc0c5 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # qiskit.dagcircuit.DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -45,19 +45,19 @@ python_api_name: qiskit.dagcircuit.DAGNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### wire - + Returns the Bit object, else None. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.mdx index 245a5eaa180..d068fb63814 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # qiskit.extensions.HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t @@ -209,19 +209,19 @@ python_api_name: qiskit.extensions.HamiltonianGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### params - + return instruction params. @@ -351,7 +351,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.24/qiskit.extensions.Initialize.mdx index 611d2a0fa74..abaf26043e6 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.24/qiskit.extensions.Initialize.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize # qiskit.extensions.Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers (assuming the qubits are in the zero state). Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. @@ -115,19 +115,19 @@ python_api_name: qiskit.extensions.Initialize ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -191,7 +191,7 @@ python_api_name: qiskit.extensions.Initialize ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.extensions.Initialize ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.mdx index 05581f86d61..3f688131f93 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot # qiskit.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -134,19 +134,19 @@ python_api_name: qiskit.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -164,7 +164,7 @@ python_api_name: qiskit.extensions.Snapshot ### label - + Return snapshot label @@ -186,7 +186,7 @@ python_api_name: qiskit.extensions.Snapshot ### params - + return instruction params. @@ -240,13 +240,13 @@ python_api_name: qiskit.extensions.Snapshot ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.mdx index 1cd9c2a1ef9..cb7c94aa28b 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate # qiskit.extensions.UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. @@ -208,19 +208,19 @@ python_api_name: qiskit.extensions.UnitaryGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### params - + return instruction params. @@ -350,7 +350,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.mdx index 208e0afb4ed..8094582a34d 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 73a25ff336a..6d890d6b050 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # qiskit.finance.components.uncertainty\_problems.EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -153,7 +153,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 3b20bd6bc8f..d64f2973af8 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # qiskit.finance.components.uncertainty\_problems.EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -157,7 +157,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 0bf8b39c6cf..af5ec15a7c0 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # qiskit.finance.components.uncertainty\_problems.FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. @@ -159,7 +159,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.mdx index 3b502b1d4c2..9d8d6aed747 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # qiskit.finance.data\_providers.BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -19,7 +19,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -138,7 +138,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.mdx index afca10753d4..cdafd892048 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # qiskit.finance.data\_providers.DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy\_tutorials/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy_tutorials/aqua/finance/data_providers/time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.mdx index cc93fe893ea..ba0da6f1063 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # qiskit.finance.data\_providers.ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy\_tutorials/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy_tutorials/aqua/finance/data_providers/time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.mdx index 5acc6b11eef..fb0dee0c1e8 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # qiskit.finance.data\_providers.RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type start: `datetime` :param start: first data point :type end: `datetime` :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.mdx index 88d2cc74d80..9662a66c593 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # qiskit.finance.data\_providers.StockMarket - + Stock Market enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 2520f7aacfd..1fc9f6ea366 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # qiskit.finance.data\_providers.WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy\_tutorials/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy_tutorials/aqua/finance/data_providers/time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.mdx index 895ca2e6d8e..9f2bf472ed7 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # qiskit.finance.data\_providers.YahooDataProvider - + Yahoo data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy\_tutorials/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy_tutorials/aqua/finance/data_providers/time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.mdx index 125a5f7bfa5..23d029ee996 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # qiskit.ignis.characterization.AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -187,7 +187,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.mdx index 82b004db570..f091dd57006 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # qiskit.ignis.characterization.AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -78,7 +78,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 574401647ce..36a0d6f7500 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # qiskit.ignis.characterization.AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -187,7 +187,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.mdx index ed7c0941bfd..7f68fadd440 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # qiskit.ignis.characterization.AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -187,7 +187,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 7f15f8b252f..5f6e53d85b7 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # qiskit.ignis.characterization.BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -173,7 +173,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.mdx index 84460fdde21..5680a2b1533 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # qiskit.ignis.characterization.BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ @@ -58,7 +58,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.mdx index aab374f4208..4ef5b9d4323 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # qiskit.ignis.characterization.DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ @@ -64,7 +64,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.mdx index 6cc2132d4e9..955055aa310 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # qiskit.ignis.characterization.RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ @@ -65,7 +65,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.mdx index 2e91bb2a73f..21bc9f23ce5 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # qiskit.ignis.characterization.T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. @@ -77,7 +77,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -87,7 +87,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -112,7 +112,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -122,7 +122,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -132,7 +132,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -142,7 +142,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -177,7 +177,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -225,7 +225,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -235,7 +235,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.mdx index 8fde5a0fb5e..fe14e294fff 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # qiskit.ignis.characterization.T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. @@ -78,7 +78,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -88,7 +88,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -113,7 +113,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -123,7 +123,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -133,7 +133,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -143,7 +143,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -178,7 +178,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -226,7 +226,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -236,7 +236,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.mdx index f13c9b1eca7..f8304cae006 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # qiskit.ignis.characterization.T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. @@ -78,7 +78,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -88,7 +88,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -113,7 +113,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -141,7 +141,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -151,7 +151,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -161,7 +161,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -244,7 +244,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -254,7 +254,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.mdx index 1183a86ee36..46b4b7a4a6f 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # qiskit.ignis.characterization.ZZFitter - + ZZ fitter ### \_\_init\_\_ @@ -78,7 +78,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.mdx index 326978bf35a..be3279f5b2d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # qiskit.ignis.logging.IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.mdx index 72fda302ec2..91b264043d6 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # qiskit.ignis.logging.IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.mdx index bcec5c0b59a..2c15ec9d192 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # qiskit.ignis.logging.IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.mdx index c984a88ef4c..c50a52ac7a2 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # qiskit.ignis.measurement.DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -78,7 +78,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index f0296b4f879..83a07d14c07 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # qiskit.ignis.measurement.IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -69,7 +69,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -87,19 +87,19 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### expected\_states - + Returns the expected states used to train the discriminator. ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. ### fitted - + True if the discriminator has been fitted to calibration data. @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 2ea9183dc06..7d5403bd3d9 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # qiskit.ignis.measurement.LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -240,7 +240,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index 078017ff2df..2231b69cbb6 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # qiskit.ignis.measurement.QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -240,7 +240,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index 48eea187de1..afa6cd9bba9 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # qiskit.ignis.measurement.SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -240,7 +240,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index ee249c313d9..0ecaa0e3098 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # qiskit.ignis.mitigation.CTMPExpvalMeasMitigator - + N-qubit CTMP measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 6043ba26f1f..1898343c3cb 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # qiskit.ignis.mitigation.CompleteExpvalMeasMitigator - + N-qubit measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 821ea2c2254..4faf2814e8e 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # qiskit.ignis.mitigation.CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits @@ -71,13 +71,13 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### cal\_matrix - + Return cal\_matrix. ### filter - + Return a measurement filter using the cal matrix. @@ -94,7 +94,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### qubit\_list - + Return list of qubits. @@ -122,7 +122,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### state\_labels - + Return state\_labels. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 74b477d0431..abb74db8273 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter - + Expectation value measurement error mitigator calibration fitter. See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. @@ -58,7 +58,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter ### mitigator - + Return the fitted mitigator object diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.mdx index e64a34a0700..2e379044253 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # qiskit.ignis.mitigation.MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. @@ -89,13 +89,13 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter ### cal\_matrix - + Return cal\_matrix. ### state\_labels - + return the state label ordering of the cal matrix diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index d6a71a50be6..ae7c27b1b63 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # qiskit.ignis.mitigation.TensoredExpvalMeasMitigator - + 1-qubit tensor product measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.mdx index 697165b2269..332795ec9ad 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # qiskit.ignis.mitigation.TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. @@ -86,25 +86,25 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### cal\_matrices - + Return cal\_matrices. ### nqubits - + Return the number of qubits. See also MeasurementFilter.apply() ### qubit\_list\_sizes - + Return \_qubit\_list\_sizes. ### substate\_labels\_list - + Return \_substate\_labels\_list diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 23aded8a233..567e3235a77 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # qiskit.ignis.mitigation.TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. @@ -74,19 +74,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### cal\_matrices - + Return cal\_matrices. ### filter - + Return a measurement filter using the cal matrices. ### nqubits - + Return \_qubit\_list\_sizes. @@ -136,7 +136,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### substate\_labels\_list - + Return \_substate\_labels\_list. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.mdx index b58af73c5f2..d80f809f279 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # qiskit.ignis.verification.AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.mdx index 6a382ad2c5b..20e636b5a85 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # qiskit.ignis.verification.AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.mdx index 2dbbaee8ace..a2b8bcfa013 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig # qiskit.ignis.verification.BConfig - + This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.mdx index efd7e2bd3da..df6624d3a3e 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # qiskit.ignis.verification.CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. **References** @@ -97,7 +97,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### atol - + The default absolute tolerance parameter for float comparisons. @@ -150,7 +150,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### key - + Return a string representation of a CNOT-dihedral object. @@ -268,7 +268,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -308,7 +308,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### qargs - + Return the qargs for the operator. @@ -342,13 +342,13 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -356,7 +356,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index f57a24f3792..ba44f468089 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # qiskit.ignis.verification.CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. @@ -90,19 +90,19 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### cliff\_lengths - + Return group elements lengths. ### fit - + Return fit as a 2 element list. ### fit\_cnotdihedral - + Return cnotdihedral fit parameters. @@ -160,43 +160,43 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### raw\_data - + Return raw\_data as 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_X - + Return the cnotdihedral X fitter. ### rbfit\_Z - + Return the cnotdihedral Z fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.mdx index 53a927cb5ca..b2797df4b36 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # qiskit.ignis.verification.GatesetTomographyFitter - + Initialize gateset tomography fitter with experimental data. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.mdx index 2d2e0761fb3..fad08777e72 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # qiskit.ignis.verification.GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.mdx index 8d0036ea7fa..3382d5a8bdd 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # qiskit.ignis.verification.InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. @@ -94,13 +94,13 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit as a 2 element list. @@ -134,7 +134,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### fit\_int - + Return interleaved fit parameters. @@ -157,43 +157,43 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### raw\_data - + Return raw\_data as a 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_int - + Return the interleaved RB fitter. ### rbfit\_std - + Return the original RB fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.mdx index ef7d5e19bd9..71741d09cf9 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter # qiskit.ignis.verification.Plotter - + Various plots of the ground state in MQC and PO experiments ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 7c9dd51ee8b..57664dcb03b 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # qiskit.ignis.verification.ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. @@ -70,7 +70,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### data - + Return tomography data @@ -148,13 +148,13 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.mdx index e8e9822a746..ec452d87c11 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # qiskit.ignis.verification.PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -114,13 +114,13 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return the purity fit parameters. @@ -163,37 +163,37 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_pur - + Return the purity RB fitter. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.mdx index bdb8f21024e..04191ad7af6 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # qiskit.ignis.verification.QVFitter - + Class for fitters for quantum volume. **Parameters** @@ -154,25 +154,25 @@ python_api_name: qiskit.ignis.verification.QVFitter ### depths - + Return depth list. ### heavy\_output\_counts - + Return the number of heavy output counts as measured. ### heavy\_output\_prob\_ideal - + Return the heavy output probability ideally. ### heavy\_outputs - + Return the ideal heavy outputs dictionary. @@ -256,7 +256,7 @@ python_api_name: qiskit.ignis.verification.QVFitter ### qubit\_lists - + Return depth list. @@ -276,13 +276,13 @@ python_api_name: qiskit.ignis.verification.QVFitter ### results - + Return all the results. ### ydata - + Return the average and std of the output probability. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.mdx index e5d83d19330..3c49818f49c 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # qiskit.ignis.verification.RBFitter - + Class for fitters for randomized benchmarking. **Parameters** @@ -93,13 +93,13 @@ python_api_name: qiskit.ignis.verification.RBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit. @@ -153,31 +153,31 @@ python_api_name: qiskit.ignis.verification.RBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.mdx index 059bd7a0d3c..a6f0165c35c 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # qiskit.ignis.verification.RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.mdx index 2404fef88ef..78e8b6fa333 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # qiskit.ignis.verification.StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### data - + Return tomography data @@ -136,13 +136,13 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.mdx index 0d7b4e0b342..fd8a84060fe 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # qiskit.ignis.verification.TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. @@ -70,7 +70,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### data - + Return tomography data @@ -141,13 +141,13 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.mdx index 456be83cf0f..352040c586a 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.mdx index 3639d812403..13b98c8fcd9 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # qiskit.optimization.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -437,7 +437,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -451,7 +451,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -505,7 +505,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -519,7 +519,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -581,7 +581,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -595,7 +595,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -670,7 +670,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -744,7 +744,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -758,7 +758,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index a8bbc288812..9d3b142c58c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # qiskit.optimization.algorithms.ADMMOptimizationResult - + ADMMOptimization Result. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### state - + returns state **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 52ca99352fe..7d04857b3c5 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # qiskit.optimization.algorithms.ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer ### parameters - + Returns current parameters of the optimizer. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.mdx index 841b1b2a5d3..bdc4c7d3caa 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # qiskit.optimization.algorithms.ADMMParameters - + Defines a set of parameters for ADMM optimizer. Defines parameters for ADMM optimizer and their default values. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.mdx index 8fa047b22f8..667a7c0b7ce 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # qiskit.optimization.algorithms.ADMMState - + Internal computation state of the ADMM implementation. The state keeps track of various variables are stored that are being updated during problem solving. The values are relevant to the problem being solved. The state is recreated for each optimization problem. State is returned as the third value. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 4cead963144..5b43161d38e 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # qiskit.optimization.algorithms.CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -77,7 +77,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -172,7 +172,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.mdx index 4d9418e5fb1..a3a807f26e3 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # qiskit.optimization.algorithms.CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -68,7 +68,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index d4af5e57c15..b273f9200f6 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # qiskit.optimization.algorithms.GroverOptimizationResult - + A result object for Grover Optimization methods. Constructs a result object with the specific Grover properties. @@ -70,7 +70,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### intermediate\_fval - + Getter of the intermediate fval **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_input\_qubits - + Getter of n\_input\_qubits **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_output\_qubits - + Getter of n\_output\_qubits **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### operation\_counts - + Get the operation counts. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -156,7 +156,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### threshold - + Getter of the threshold of Grover algorithm. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.mdx index aec00b8581c..ba140b31ce3 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # qiskit.optimization.algorithms.GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** @@ -96,7 +96,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer ### quantum\_instance - + The quantum instance to run the circuits. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.mdx index ee6210c0d3a..5c44f7f419e 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # qiskit.optimization.algorithms.IntermediateResult - + Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index a5cb64d74e0..e149a4b2496 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # qiskit.optimization.algorithms.MinimumEigenOptimizationResult - + Minimum Eigen Optimizer Result. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### min\_eigen\_solver\_result - + Returns a result object obtained from the instance of `MinimumEigensolver`. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -108,7 +108,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### samples - + Returns samples. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -174,7 +174,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index 99aafe98e54..197d6522f35 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # qiskit.optimization.algorithms.MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer ### min\_eigen\_solver - + Returns the minimum eigensolver. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index e11ab4b8498..cb9184fe5c6 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # qiskit.optimization.algorithms.MultiStartOptimizer - + An abstract class that implements multi start optimization and should be sub-classed by other optimizers. Constructs an instance of this optimizer. @@ -50,7 +50,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. @@ -143,7 +143,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index c7b0001ded8..122ecd5e5ee 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # qiskit.optimization.algorithms.OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ### \_\_init\_\_ @@ -30,7 +30,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.mdx index f4c9f7c74a5..283027f44a1 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # qiskit.optimization.algorithms.OptimizationResult - + A base class for optimization results. The optimization algorithms return an object of the type `OptimizationResult` with the information about the solution obtained. @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -127,7 +127,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index fa21fc4347a..a85b973d3c8 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # qiskit.optimization.algorithms.OptimizationResultStatus - + Termination status of an optimization algorithm. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 9d4d0446a5d..9c93b0ca97f 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult - + Recursive Eigen Optimizer Result. Constructs an instance of the result class. @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### fval - + Returns the optimal function value. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### history - + Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -101,7 +101,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### replacements - + Returns a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index aa35c8fe886..d4def73da22 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index 06ad07996b9..22ee32f13c6 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # qiskit.optimization.algorithms.SlsqpOptimizationResult - + SLSQP optimization result, defines additional properties that may be returned by the optimizer. Constructs a result object with properties specific to SLSQP. @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fx - + Returns the final value of the objective function being actually optimized. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### imode - + Returns the exit mode from the optimizer. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### its - + Returns the number of iterations **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -127,7 +127,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### smode - + Returns message describing the exit mode from the optimizer. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index e77b904e291..1958855b0e0 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # qiskit.optimization.algorithms.SlsqpOptimizer - + The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx index e1f5dfb955e..c956a7a99c4 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx @@ -34,12 +34,12 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord - + Alias for field number 2 @@ -51,7 +51,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### dim - + Alias for field number 1 @@ -65,13 +65,13 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### name - + Alias for field number 0 #### w - + Alias for field number 3 diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.mdx index 762bc2da4c8..7cca766b62c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # qiskit.optimization.converters.InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** @@ -136,7 +136,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality ### mode - + Returns the mode of the converter **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.mdx index ad331c58af6..b6bf2c9b843 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # qiskit.optimization.converters.IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index 0de9b17e01c..7f94eb1ea7d 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # qiskit.optimization.converters.LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 7ceb54fb20f..f03aaa43e9d 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # qiskit.optimization.converters.QuadraticProgramConverter - + An abstract class for converters of quadratic programs in Qiskit’s optimization module. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index b4985d79ad2..c4a49e16648 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # qiskit.optimization.converters.QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. @@ -154,7 +154,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.mdx index 5224846ffe3..950984a391f 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint # qiskit.optimization.problems.Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.mdx index 42591fce083..bbb6291529a 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # qiskit.optimization.problems.LinearConstraint - + Representation of a linear constraint. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.mdx index c954b495be5..980c51f218c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # qiskit.optimization.problems.LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.mdx index e355a2e12ae..fd014af5005 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # qiskit.optimization.problems.QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.mdx index c608852e84e..062333fd2a2 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # qiskit.optimization.problems.QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.mdx index 376d761ce13..3bfc0c8e703 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # qiskit.optimization.problems.QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. @@ -63,7 +63,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### sense - + Returns the sense of the objective function. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.mdx index 345cc5ce2b5..20720553251 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # qiskit.optimization.problems.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -437,7 +437,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -451,7 +451,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -505,7 +505,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -519,7 +519,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -581,7 +581,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -595,7 +595,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -670,7 +670,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -744,7 +744,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -758,7 +758,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.mdx index b184fb5205e..2fa1614db33 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # qiskit.optimization.problems.QuadraticProgramElement - + Interface class for all objects that have a parent QuadraticProgram. Initialize object with parent QuadraticProgram. @@ -51,7 +51,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.mdx index cc325adec66..8722ef080a5 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable # qiskit.optimization.problems.Variable - + Representation of a variable. Creates a new Variable. @@ -88,7 +88,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.24/qiskit.providers.Backend.mdx index ba3b196b382..cf02bbac638 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.Backend.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend # qiskit.providers.Backend - + Base common type for all versioned Backend abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.mdx index c1460dec0bd..bb471b6169e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.24/qiskit.providers.BackendV1.mdx index e7e77768f21..7508a1d14d8 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.BackendV1.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 # qiskit.providers.BackendV1 - + Abstract class for Backends This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.BackendV1 ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. @@ -131,7 +131,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.mdx index 5cb5bb9c025..6913684c5c8 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend # qiskit.providers.BaseBackend - + Legacy Base class for backends. Base class for backends. @@ -28,7 +28,7 @@ python_api_name: qiskit.providers.BaseBackend ### \_\_init\_\_ - + Base class for backends. This method should initialize the module and its configuration, and raise an exception if a component of the module is not available. @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.BaseJob.mdx index 0917f1f3956..1b4cb9a1283 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob # qiskit.providers.BaseJob - + Legacy Class to handle asynchronous jobs Initializes the asynchronous job. @@ -60,7 +60,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -106,7 +106,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -122,13 +122,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.mdx index 2e12706e6a5..82ad4bbba8b 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider # qiskit.providers.BaseProvider - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.Job.mdx b/docs/api/qiskit/0.24/qiskit.providers.Job.mdx index 9026ac596ba..dc1c2ab4177 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.Job.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job # qiskit.providers.Job - + Base common type for all versioned Job abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.24/qiskit.providers.JobError.mdx index 2e823594586..e55c729e45e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.JobError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.24/qiskit.providers.JobStatus.mdx index 798a2da726f..026b3e4ae7e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.JobStatus.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus # qiskit.providers.JobStatus - + Class for job status enumerated type. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.mdx index 40207cd726f..cc422da7baf 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.24/qiskit.providers.JobV1.mdx index 08eea1403d9..d30c5f820bc 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.JobV1.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 # qiskit.providers.JobV1 - + Class to handle jobs This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. @@ -116,7 +116,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -132,13 +132,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.24/qiskit.providers.Options.mdx b/docs/api/qiskit/0.24/qiskit.providers.Options.mdx index 7b0033bf270..a4e54d2b3c0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.Options.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options # qiskit.providers.Options - + Base options object This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. diff --git a/docs/api/qiskit/0.24/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.24/qiskit.providers.Provider.mdx index dec35dfc12b..6f59934823e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.Provider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider # qiskit.providers.Provider - + Base common type for all versioned Provider abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.mdx index 3984297d1ad..851dbc4cec0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 # qiskit.providers.ProviderV1 - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.mdx index c0038dbe3aa..e08fd3d753f 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.mdx index 901420f6a6c..9eeab8be9a1 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.mdx index 9f71bd782f7..fc724844239 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob # qiskit.providers.aer.AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.mdx index 99d51c5f90d..b5dca74f0ac 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider # qiskit.providers.aer.AerProvider - + Provider for Qiskit Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.mdx index 4bf23138702..2c0be896608 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # qiskit.providers.aer.PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. @@ -197,7 +197,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### options - + Return the current simulator options diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.mdx index d4978000a08..72043923222 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # qiskit.providers.aer.QasmSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -199,7 +199,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. @@ -219,7 +219,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### options - + Return the current simulator options diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.mdx index d78a051a244..75f54f71e41 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # qiskit.providers.aer.StatevectorSimulator - + Ideal quantum circuit statevector simulator **Configurable Options** @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### options - + Return the current simulator options diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.mdx index f62dda3c617..a6f822124a9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # qiskit.providers.aer.UnitarySimulator - + Ideal quantum circuit unitary simulator. **Configurable Options** @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### options - + Return the current simulator options diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.mdx index d78cda17fcc..0f272c05856 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # qiskit.providers.aer.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -135,25 +135,25 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -171,7 +171,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### label - + Return snapshot label @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### params - + return instruction params. @@ -247,13 +247,13 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 592c88aa3bc..26d39cf84d9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # qiskit.providers.aer.extensions.SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -129,25 +129,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### label - + Return snapshot label @@ -187,7 +187,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### params - + return instruction params. @@ -241,13 +241,13 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index d7a94294292..83e37299d24 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # qiskit.providers.aer.extensions.SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create an expectation value snapshot instruction. @@ -133,25 +133,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### label - + Return snapshot label @@ -191,7 +191,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### params - + return instruction params. @@ -245,13 +245,13 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 7ee1e7438f8..43e02160edf 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # qiskit.providers.aer.extensions.SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -131,25 +131,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -167,7 +167,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### label - + Return snapshot label @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### params - + return instruction params. @@ -243,13 +243,13 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index fd673ba89df..8b18d149e38 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # qiskit.providers.aer.extensions.SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -137,25 +137,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### label - + Return snapshot label @@ -195,7 +195,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### params - + return instruction params. @@ -249,13 +249,13 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index a26afc9f59c..d81c97ccfaa 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # qiskit.providers.aer.extensions.SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -137,25 +137,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### label - + Return snapshot label @@ -195,7 +195,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### params - + return instruction params. @@ -249,13 +249,13 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### snapshot\_type - + Return snapshot type ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.mdx index be7ea89bb8c..cf7ff3150ac 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # qiskit.providers.aer.noise.NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -214,13 +214,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### basis\_gates - + Return basis\_gates for compiling to the noise model. ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -282,7 +282,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** @@ -310,13 +310,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### noise\_instructions - + Return the set of noisy instructions for this noise model. ### noise\_qubits - + Return the set of noisy qubits for this noise model. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.mdx index 45c3d77a838..104de277329 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # qiskit.providers.aer.noise.QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -115,13 +115,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### atol - + The default absolute tolerance parameter for float comparisons. ### circuits - + Return the list of error circuits. @@ -233,7 +233,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -261,31 +261,31 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### probabilities - + Return the list of error probabilities. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. ### size - + Return the number of error circuit. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.mdx index aabc3f0ce6c..4e73d93e674 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # qiskit.providers.aer.noise.ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### atol - + The default absolute tolerance parameter for float comparisons. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -224,25 +224,25 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### probabilities - + Return the readout error probabilities matrix. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.mdx index eddacbe1084..3909bdc2194 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # qiskit.providers.aer.pulse.PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -111,7 +111,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.mdx index a41b7d9ebd1..7a1710b20d2 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # qiskit.providers.aer.utils.NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ### \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -109,13 +109,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -213,7 +213,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.mdx index a39a7867df5..d797e30f056 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.mdx index 9f45f66bd59..6aa8c7be5a9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # qiskit.providers.basicaer.BasicAerJob - + BasicAerJob class. ### \_executor diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.mdx index 4687005cf8d..8f409361999 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # qiskit.providers.basicaer.BasicAerProvider - + Provider for Basic Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 3298b296433..bc724ca897c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # qiskit.providers.basicaer.QasmSimulatorPy - + Python implementation of a qasm simulator. Base class for backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index d9fb6a0591f..d467fd5a67f 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # qiskit.providers.basicaer.StatevectorSimulatorPy - + Python statevector simulator. Base class for backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 9de05c318ae..fc6e848550f 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # qiskit.providers.basicaer.UnitarySimulatorPy - + Python implementation of a unitary simulator. Base class for backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.mdx index 57a7a129ada..c9a8662cc2d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # qiskit.providers.ibmq.AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. @@ -96,7 +96,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### backend - + Return the backend service. **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### experiment - + Return the experiment service. **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### random - + Return the random number service. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.mdx index 6c2389c0bbf..48d064e5a72 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # qiskit.providers.ibmq.BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 775b33ffc54..2829c7056eb 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 3715a52b450..488b118fce7 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 7be13f68e1c..494e6d0ca1e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index ba8d2b03338..69297c2e6fe 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.mdx index c572f0748fd..ae75cd02bac 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 51081b4e398..c7091424cd5 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.mdx index 909933a8ea5..795806bdc96 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # qiskit.providers.ibmq.IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -267,7 +267,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 765ba0ca033..b0e23277808 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 363910127f7..d85c4807ad1 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.mdx index 16901dc2ed3..dd1136bbe73 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.mdx index 3f5d9795520..d236e95ae8a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # qiskit.providers.ibmq.IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 23cf6188677..3a521f324dd 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.mdx index 4c8e0221f56..aac393f6dd9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.mdx index 113eb40bc8f..11e949b1b68 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # qiskit.providers.ibmq.IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -231,7 +231,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.mdx index 19153d51e02..8ed9866f656 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.mdx index 8f867802cb3..905837d37b6 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # qiskit.providers.ibmq.credentials.Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 99783b75f74..52e2c918881 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 5b76c693d74..86be118534e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index b4f28898c22..4fd30f4244c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.mdx index f52d0e35923..25ee3124f47 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult # qiskit.providers.ibmq.experiment.AnalysisResult - + Class representing an analysis result for an experiment. AnalysisResult constructor. @@ -73,7 +73,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### fit - + Return the fit value for the experiment. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### quality - + Return the analysis result quality. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### uuid - + Return UUID of this analysis result. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.mdx index 53e6e89c298..0571aaa5ddb 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment # qiskit.providers.ibmq.experiment.Experiment - + Class representing an experiment. Experiment constructor. @@ -138,7 +138,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### analysis\_results - + Return analysis results associated with this experiment. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### backend\_name - + Return the experiment’s backend name. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### end\_datetime - + Return the timestamp when the experiment ended. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### group - + Return the experiment’s group. **Return type** @@ -207,7 +207,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### hub - + Return the experiment’s hub. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### owner - + Return the experiment’s owner. **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### plot\_names - + Return names of plots associated with this experiment. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### project - + Return the experiment’s project. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### share\_level - + Return the experiment share\_level. **Return type** @@ -267,7 +267,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### start\_datetime - + Return the timestamp when the experiment started. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -301,7 +301,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### uuid - + Return the experiment’s uuid. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.mdx index 60ec73c5c1e..64058bc8857 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService # qiskit.providers.ibmq.experiment.ExperimentService - + Provides experiment related services. This class is the main interface to invoke IBM Quantum Experience experiment services, which allow you to create, delete, update, query, and retrieve experiments, experiment plots, and analysis results. The `experiment` attribute of `AccountProvider` is an instance of this class, and the main syntax for using the services is `provider.experiment.`. For example: diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.mdx index 23b593f5e34..2ef44c91087 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # qiskit.providers.ibmq.job.IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -212,7 +212,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### experiment\_id - + Return the experiment ID. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 6ce2b280113..0d270530c27 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.mdx index 211e8f2733c..6cc6f3db516 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index c79d333346c..d109802c978 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index be943a78c52..c865dad0886 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 592248c66d4..cfd4e569052 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.mdx index 2d13b098a3e..1dd40d7a53c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # qiskit.providers.ibmq.job.QueueInfo - + Queue information for a job. QueueInfo constructor. @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index dbac44943ee..06b3685ad8d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # qiskit.providers.ibmq.managed.IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index d33b7b39d69..171faec05c2 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 5a81c7007ba..565fba19105 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index fea4906634a..6569d05bf9a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index fc54a1643cd..37aa8f69245 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 245b5cf1741..7896bc54ea5 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 7d7bfbcca1b..73a5f426e4d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.mdx index aabad6bfaf6..7167f7aadab 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # qiskit.providers.ibmq.managed.ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 88a891aa38f..ecaed9b75bd 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # qiskit.providers.ibmq.managed.ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.mdx index b44e913b377..b61ce294751 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # qiskit.providers.ibmq.managed.ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.mdx index 68278a003cc..94a0d859874 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # qiskit.providers.ibmq.random.CQCExtractor - + Class for interfacing with a CQC remote extractor. There are two extractor methods - Dodis (extractor 1) and Hayashi (extractor 2). These methods can be invoked synchronously or asynchronously. To invoke them synchronously: diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index dee302fcb49..022c3e8a048 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # qiskit.providers.ibmq.random.CQCExtractorJob - + Representation of an asynchronous call to the CQC extractor. An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. @@ -88,7 +88,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### extractor\_method - + Return the extractor method used. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### parameters - + Return the parameters passed to the extractor. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 4ba8b922359..5eb319700e4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # qiskit.providers.ibmq.random.IBMQRandomService - + Random number services for an IBM Quantum Experience account provider. Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.mdx index ca8ef411cee..e16f3fdd3ea 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # qiskit.providers.models.BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.mdx index 53bb72924c6..022b31217ce 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties # qiskit.providers.models.BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general propeties of the backend. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.mdx index 77096bc53c7..89edcb1fc68 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus # qiskit.providers.models.BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -55,7 +55,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.Command.mdx index 35377ac1a40..6714f6f184d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.Command.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command # qiskit.providers.models.Command - + Class representing a Command. ### name @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.mdx index d42f87f924d..c4a0b1e9a7c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig # qiskit.providers.models.GateConfig - + Class representing a Gate Configuration ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.mdx index b01d0a88a7c..26ae766bc5b 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus # qiskit.providers.models.JobStatus - + Model for JobStatus. ### job\_id @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.mdx index ce259661d83..432d55ad9ed 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # qiskit.providers.models.PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -224,7 +224,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. @@ -304,7 +304,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### sample\_rate - + Sample rate of the signal channels in Hz (1/dt). **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.mdx index 74916e8fec6..6122277c5fb 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # qiskit.providers.models.PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_est: `List`\[`float`] :param qubit\_freq\_est: Estimated qubit frequencies in GHz. :type meas\_freq\_est: `List`\[`float`] :param meas\_freq\_est: Estimated measurement cavity frequencies in GHz. :type buffer: `int` :param buffer: Default buffer time (in units of dt) between pulses. :type pulse\_library: `List`\[`PulseLibraryItem`] :param pulse\_library: Pulse name and sample definitions. :type cmd\_def: `List`\[`Command`] :param cmd\_def: Operation name and definition in terms of Commands. :type meas\_kernel: `Optional`\[`MeasurementKernel`] :param meas\_kernel: The measurement kernels :type discriminator: `Optional`\[`Discriminator`] :param discriminator: The discriminators :param \*\*kwargs: Other attributes for the super class. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.mdx index 15c58e9e6ac..93d910f090b 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # qiskit.providers.models.QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.mdx index 2695e2acfc4..aa8131d7667 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO # qiskit.providers.models.UchannelLO - + Class representing a U Channel LO ### q @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Acquire.mdx index 2c2ce422e08..737ac1953a2 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Acquire.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire # qiskit.pulse.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -96,7 +96,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.pulse.Acquire ### acquires - + Acquire channels to be acquired on. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.pulse.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns channels that this schedule uses. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.pulse.Acquire ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -330,7 +330,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slots - + MemorySlots. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -360,7 +360,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slots - + RegisterSlots. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -415,7 +415,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** @@ -425,7 +425,7 @@ python_api_name: qiskit.pulse.Acquire ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.mdx index 8dc6956d7b2..2b77c6b098b 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel # qiskit.pulse.AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Constant.mdx index cc8af7e1c68..40474dd754d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Constant.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant # qiskit.pulse.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -59,7 +59,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -130,7 +130,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -140,7 +140,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.mdx index 7b11a984e9e..f654bca5c93 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel # qiskit.pulse.ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.ControlChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.ControlChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Delay.mdx index 377f86a3614..ca9a7e728e5 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Delay.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay # qiskit.pulse.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -157,7 +157,7 @@ python_api_name: qiskit.pulse.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns channels that this schedule uses. **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.pulse.Delay ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -220,7 +220,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -311,7 +311,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.Delay ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Drag.mdx index f8fdd9ef9b0..f17b7cbb998 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Drag.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag # qiskit.pulse.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -77,7 +77,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -105,7 +105,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -158,7 +158,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -168,7 +168,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -178,7 +178,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.mdx index d131efac043..e02a9a09279 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel # qiskit.pulse.DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.DriveChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.DriveChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.mdx index d44b528262f..8d0fb2ada4c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian # qiskit.pulse.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -61,7 +61,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -132,7 +132,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -142,7 +142,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -152,7 +152,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.mdx index 35774bb5cd9..1a8e1a00044 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare # qiskit.pulse.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -64,7 +64,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -135,7 +135,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -145,7 +145,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -155,7 +155,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -179,7 +179,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Instruction.mdx index 1200ee8c6cc..795198603ab 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Instruction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction # qiskit.pulse.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns channels that this schedule uses. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.Instruction ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -205,7 +205,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -296,7 +296,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.Instruction ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.mdx index 0c0723578cf..e0e6e4c9bab 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.mdx @@ -10,7 +10,7 @@ python_api_name: 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: ```python @@ -150,7 +150,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap ### instructions - + Return all instructions which have definitions. By default, these are typically the basis gates along with other instructions such as measure and reset. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.mdx index d1f7728ee6f..bfb1af97dd7 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel # qiskit.pulse.MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.mdx index b13b32a5b9b..690e0351697 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot # qiskit.pulse.MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.MemorySlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.MemorySlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Play.mdx index 578a322f537..bb944dd4385 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Play.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play # qiskit.pulse.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns channels that this schedule uses. **Return type** @@ -172,7 +172,7 @@ python_api_name: qiskit.pulse.Play ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -215,7 +215,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.pulse.Play ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.24/qiskit.pulse.PulseError.mdx index 8e3b27d94d2..9ea56a8d00a 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.PulseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.mdx index 5688ba1a1da..aba79d73702 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot # qiskit.pulse.RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Schedule.mdx index 63f5727d77e..42c899eb60e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Schedule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule # qiskit.pulse.Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Create an empty schedule. @@ -146,7 +146,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -198,7 +198,7 @@ $$ ### duration - + Duration of this schedule component. **Return type** @@ -277,7 +277,7 @@ $$ ### instructions - + Get the time-ordered instructions from self. **ReturnType:** @@ -287,7 +287,7 @@ $$ ### name - + Name of ScheduleComponent. **Return type** @@ -372,7 +372,7 @@ $$ ### start\_time - + Starting time of this schedule component. **Return type** @@ -382,7 +382,7 @@ $$ ### stop\_time - + Stopping time of this schedule component. **Return type** @@ -392,7 +392,7 @@ $$ ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.mdx index 342069843d7..e84327b6467 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency # qiskit.pulse.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -150,7 +150,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -160,7 +160,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -170,7 +170,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -213,7 +213,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -233,7 +233,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -243,7 +243,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -269,7 +269,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -279,7 +279,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -289,7 +289,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -314,7 +314,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -324,7 +324,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -334,7 +334,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.mdx index 85ae03deb57..6b6841d7a1e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase # qiskit.pulse.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -150,7 +150,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -160,7 +160,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -170,7 +170,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -213,7 +213,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -233,7 +233,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -259,7 +259,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -279,7 +279,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -289,7 +289,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -314,7 +314,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -324,7 +324,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -334,7 +334,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.mdx index 97df29d54cc..d4a4f45a099 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # qiskit.pulse.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -142,7 +142,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channels - + Returns channels that this schedule uses. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -205,7 +205,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.mdx index 69a1e70549d..cee6fbcaedd 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase # qiskit.pulse.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -172,7 +172,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -215,7 +215,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -235,7 +235,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -316,7 +316,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -326,7 +326,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -336,7 +336,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.mdx index efe9342f66c..76ba6e59232 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot # qiskit.pulse.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -151,7 +151,7 @@ python_api_name: qiskit.pulse.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns channels that this schedule uses. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.pulse.Snapshot ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -214,7 +214,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -315,7 +315,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -325,7 +325,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -335,7 +335,7 @@ python_api_name: qiskit.pulse.Snapshot ### timeslots - + Occupied time slots by this instruction. **Return type** @@ -345,7 +345,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.24/qiskit.pulse.Waveform.mdx index ebfc83e8282..2593d6573d8 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.Waveform.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform # qiskit.pulse.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.pulse.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.24/qiskit.pulse.channels.mdx index 1cd3c6fd0af..9cd2949fc32 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.channels.mdx @@ -36,7 +36,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -51,7 +51,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -61,7 +61,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -72,7 +72,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. Channel class. @@ -87,7 +87,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -97,7 +97,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -114,7 +114,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -129,7 +129,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -139,7 +139,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -150,7 +150,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -165,7 +165,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -175,7 +175,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -186,7 +186,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -201,7 +201,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -211,7 +211,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -222,7 +222,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -237,7 +237,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -247,7 +247,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -258,7 +258,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -273,7 +273,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -283,7 +283,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -294,7 +294,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -309,7 +309,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -319,7 +319,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -330,14 +330,14 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify instructions for simulators. Create new snapshot channel. #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -347,7 +347,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.mdx index 1008c032bb9..9d76302aeae 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # qiskit.pulse.instructions.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -96,7 +96,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquires - + Acquire channels to be acquired on. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns channels that this schedule uses. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -330,7 +330,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slots - + MemorySlots. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -360,7 +360,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slots - + RegisterSlots. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -415,7 +415,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** @@ -425,7 +425,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.mdx index 08c88151abd..00fd57f9f8a 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay # qiskit.pulse.instructions.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -157,7 +157,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns channels that this schedule uses. **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -220,7 +220,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -311,7 +311,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.mdx index 96aef972f7c..2f4073bdabc 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # qiskit.pulse.instructions.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns channels that this schedule uses. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -205,7 +205,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -296,7 +296,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.mdx index 97e48902dad..e2c734f3518 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play # qiskit.pulse.instructions.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns channels that this schedule uses. **Return type** @@ -172,7 +172,7 @@ python_api_name: qiskit.pulse.instructions.Play ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -215,7 +215,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.pulse.instructions.Play ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.mdx index d1ef5458b3e..d0857183e5e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # qiskit.pulse.instructions.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -150,7 +150,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -160,7 +160,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -170,7 +170,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -213,7 +213,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -233,7 +233,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -243,7 +243,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -269,7 +269,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -279,7 +279,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -289,7 +289,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -314,7 +314,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -324,7 +324,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -334,7 +334,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.mdx index e60480ca55e..c3629dcc129 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # qiskit.pulse.instructions.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -150,7 +150,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -160,7 +160,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -170,7 +170,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -213,7 +213,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -233,7 +233,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -259,7 +259,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -279,7 +279,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -289,7 +289,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -314,7 +314,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -324,7 +324,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -334,7 +334,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.mdx index 8f5add6f200..650f1793b1c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # qiskit.pulse.instructions.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -142,7 +142,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channels - + Returns channels that this schedule uses. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -205,7 +205,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.mdx index 0d00c4722c6..c55208a7b8d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # qiskit.pulse.instructions.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -172,7 +172,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -215,7 +215,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -235,7 +235,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -316,7 +316,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -326,7 +326,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -336,7 +336,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.mdx index 02b4b35e2e7..2373a717084 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # qiskit.pulse.instructions.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -151,7 +151,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns channels that this schedule uses. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Returns** @@ -214,7 +214,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -315,7 +315,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -325,7 +325,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -335,7 +335,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### timeslots - + Occupied time slots by this instruction. **Return type** @@ -345,7 +345,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.mdx index e54fb85085d..5af6297886e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant # qiskit.pulse.library.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -59,7 +59,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -130,7 +130,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -140,7 +140,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.mdx index b19e5d2966e..b2042d3491b 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag # qiskit.pulse.library.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -77,7 +77,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -105,7 +105,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -158,7 +158,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -168,7 +168,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -178,7 +178,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.mdx index 13e14689533..824a918385a 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian # qiskit.pulse.library.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -61,7 +61,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -132,7 +132,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -142,7 +142,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -152,7 +152,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.mdx index 30d2f30c758..4db485c69fb 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # qiskit.pulse.library.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -64,7 +64,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -135,7 +135,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -145,7 +145,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -155,7 +155,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -179,7 +179,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.mdx index be2d985f276..6a1dd4cbf2e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform # qiskit.pulse.library.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.library.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.pulse.library.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.mdx index 69f85efbb93..d032f6db25b 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # qiskit.qasm.OpenQASMLexer - + A pygments lexer for OpenQasm. ### \_\_init\_\_ @@ -51,7 +51,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.24/qiskit.qasm.Qasm.mdx index 65dd33d5087..a5de7dba8bf 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.24/qiskit.qasm.Qasm.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm # qiskit.qasm.Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.24/qiskit.qasm.QasmError.mdx index 055a58a6c4e..2bd45cb23d3 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.mdx index 59b15e45555..1c7b0e77c8c 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # qiskit.qasm.QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.mdx index f71e6a0c54f..9f838fea3eb 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # qiskit.qasm.QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.mdx index fe475c48c06..826bec1bd0d 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration # qiskit.qobj.GateCalibration - + Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. Initialize a single gate calibration. Instructions may reference waveforms which should be made available in the pulse\_library. @@ -45,7 +45,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.mdx index 1e6f67821a3..f6566bdd23c 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # qiskit.qobj.PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.mdx index 852a0007184..112a71be368 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj # qiskit.qobj.PulseQobj - + A Pulse Qobj. Instatiate a new Pulse Qobj Object. @@ -49,7 +49,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.mdx index 22298cd71d7..61fe8220907 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # qiskit.qobj.PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -63,7 +63,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.mdx index e973405a318..37f1034338d 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # qiskit.qobj.PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -45,7 +45,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.mdx index a1cb7dc30f6..854aea7f1a0 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # qiskit.qobj.PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.mdx index 60883452efc..e93378f35f5 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # qiskit.qobj.PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -71,7 +71,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.mdx index 51cf7811ab7..12250fedeb4 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # qiskit.qobj.QasmExperimentCalibrations - + A container for any calibrations data. The gates attribute contains a list of GateCalibrations. Initialize a container for calibrations. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.mdx index 41b2b8202e1..9eca392582f 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj # qiskit.qobj.QasmQobj - + A QASM Qobj. Instatiate a new QASM Qobj Object. @@ -49,7 +49,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.mdx index 1b70bdb34c2..f9fec621d5b 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # qiskit.qobj.QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -59,7 +59,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.mdx index cfccdf58a44..60887be3a53 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # qiskit.qobj.QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -45,7 +45,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.mdx index 710b50fc592..4957f712d89 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # qiskit.qobj.QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.mdx index 30d4c0d27fe..ae57fd5060c 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # qiskit.qobj.QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instatiate a new QasmQobjInstruction object. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.24/qiskit.qobj.Qobj.mdx index 2dbeb690057..31142b8df54 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.Qobj.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj # qiskit.qobj.Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -31,7 +31,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.mdx index d976c4e02a8..03cfea62524 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # qiskit.qobj.QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.mdx index 5b5267916da..7807e158a7f 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader # qiskit.qobj.QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.mdx index b95e0eb7555..a9a090b1a1d 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # qiskit.qobj.QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.mdx index 983d7782ad2..f3ab83b9fda 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi # qiskit.quantum\_info.Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -131,7 +131,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -177,13 +177,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -288,7 +288,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -322,7 +322,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -356,13 +356,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -370,7 +370,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.mdx index 91bbc8def0e..accf2c86fb2 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi # qiskit.quantum\_info.Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -139,7 +139,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -185,13 +185,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -296,7 +296,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -330,7 +330,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -364,13 +364,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -378,7 +378,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.mdx index 504b971bb53..ea089272bd7 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford # qiskit.quantum\_info.Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -145,7 +145,7 @@ python_api_name: qiskit.quantum_info.Clifford ### atol - + The default absolute tolerance parameter for float comparisons. @@ -191,13 +191,13 @@ python_api_name: qiskit.quantum_info.Clifford ### destabilizer - + Return the destabilizer block of the StabilizerTable. ### dim - + Return tuple (input\_shape, output\_shape). @@ -244,7 +244,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -266,13 +266,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -356,7 +356,7 @@ python_api_name: qiskit.quantum_info.Clifford ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -390,7 +390,7 @@ python_api_name: qiskit.quantum_info.Clifford ### qargs - + Return the qargs for the operator. @@ -424,13 +424,13 @@ python_api_name: qiskit.quantum_info.Clifford ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -438,7 +438,7 @@ python_api_name: qiskit.quantum_info.Clifford ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead @@ -446,7 +446,7 @@ python_api_name: qiskit.quantum_info.Clifford ### stabilizer - + Return the stabilizer block of the StabilizerTable. @@ -472,7 +472,7 @@ python_api_name: qiskit.quantum_info.Clifford ### table - + Return StabilizerTable diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.mdx index b6b021cd801..404f6276fc5 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # qiskit.quantum\_info.DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -124,7 +124,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### atol - + The absolute tolerance parameter for float comparisons. @@ -142,13 +142,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### data - + Return data. ### dim - + Return total state dimension. @@ -224,7 +224,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -248,7 +248,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -274,7 +274,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -355,7 +355,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -483,7 +483,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### rtol - + The relative tolerance parameter for float comparisons. @@ -545,7 +545,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -553,7 +553,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.mdx index 7f943a380c7..f8047e6474c 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus # qiskit.quantum\_info.Kraus - + Kraus representation of a quantum channel. The Kraus representation for a quantum channel $\mathcal{E}$ is a set of matrices $[A_0,...,A_{K-1}]$ such that @@ -137,7 +137,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -183,13 +183,13 @@ $$ ### data - + Return list of Kraus matrices for channel. ### dim - + Return tuple (input\_shape, output\_shape). @@ -294,7 +294,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -328,7 +328,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -362,13 +362,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -376,7 +376,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index df40cc112a6..575aaf2be53 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # qiskit.quantum\_info.OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ euler parameters are used. @@ -107,7 +107,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer ### basis - + The decomposition basis. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.mdx index d36dac87d85..96e1553f50b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator # qiskit.quantum\_info.Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -128,7 +128,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -174,13 +174,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -251,7 +251,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -313,7 +313,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -347,7 +347,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -381,13 +381,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -395,7 +395,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.mdx index 55d255b5d6c..27cf6e45b2f 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM # qiskit.quantum\_info.PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -139,7 +139,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -185,13 +185,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -296,7 +296,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -330,7 +330,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -364,13 +364,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -378,7 +378,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.mdx index c22c2f35ca8..de040e4877b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli # qiskit.quantum\_info.Pauli - + A simple class representing Pauli Operators. The form is P\_zx = (-i)^dot(z,x) Z^z X^x where z and x are elements of Z\_2^n. That is, there are 4^n elements (no phases in this group). @@ -131,7 +131,7 @@ python_api_name: qiskit.quantum_info.Pauli ### from\_label - + Take pauli string to construct pauli. The qubit index of pauli label is q\_\{n-1} … q\_0. E.g., a pauli is \$P\_\{n-1} otimes … otimes P\_0\$ @@ -205,13 +205,13 @@ python_api_name: qiskit.quantum_info.Pauli ### num\_qubits - + Number of qubits. ### pauli\_single - + Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit.quantum_info.Pauli ### random - + Return a random Pauli on number of qubits. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.Pauli ### sgn\_prod - + Multiply two Paulis and track the phase. \$P\_3 = P\_1 otimes P\_2\$: X\*Y @@ -377,13 +377,13 @@ python_api_name: qiskit.quantum_info.Pauli ### x - + Getter of x. ### z - + Getter of z. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.mdx index 19f1a435dca..fd7c7401a5e 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable # qiskit.quantum\_info.PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -151,13 +151,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). @@ -229,13 +229,13 @@ $$ ### array - + The underlying boolean array. ### atol - + The default absolute tolerance parameter for float comparisons. @@ -362,7 +362,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -445,7 +445,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -560,7 +560,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -594,7 +594,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -628,13 +628,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -642,7 +642,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead @@ -650,13 +650,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.mdx index e430976fa12..9a8813b979b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion # qiskit.quantum\_info.Quaternion - + A class representing a Quaternion. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.mdx index 5425a030cc9..472a43f8009 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # qiskit.quantum\_info.ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -106,13 +106,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### atol - + The default absolute tolerance parameter for float comparisons. ### coeff - + Return the coefficient @@ -158,7 +158,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -275,7 +275,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### qargs - + Return the qargs for the operator. @@ -309,13 +309,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -323,7 +323,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.mdx index 594339fe85f..bda8a661e67 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # qiskit.quantum\_info.SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -118,13 +118,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### atol - + The default absolute tolerance parameter for float comparisons. ### coeffs - + Return the Pauli coefficients. @@ -167,7 +167,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -219,13 +219,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this contruction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -336,7 +336,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -370,7 +370,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### qargs - + Return the qargs for the operator. @@ -404,13 +404,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -418,7 +418,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead @@ -445,7 +445,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### size - + The number of Pauli of Pauli terms in the operator. @@ -471,7 +471,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### table - + Return the the PauliTable. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.mdx index 7992528fd79..765ae14f0d6 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # qiskit.quantum\_info.StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -165,13 +165,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). @@ -245,13 +245,13 @@ $$ ### array - + The underlying boolean array. ### atol - + The default absolute tolerance parameter for float comparisons. @@ -389,7 +389,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -481,7 +481,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -608,7 +608,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -620,13 +620,13 @@ $$ ### pauli - + Return PauliTable ### phase - + Return phase vector @@ -654,7 +654,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -688,13 +688,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -702,7 +702,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead @@ -710,13 +710,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.mdx index 15980cc7062..3cf3d76d8c3 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector # qiskit.quantum\_info.Statevector - + Statevector class Initialize a statevector object. @@ -124,7 +124,7 @@ python_api_name: qiskit.quantum_info.Statevector ### atol - + The absolute tolerance parameter for float comparisons. @@ -142,13 +142,13 @@ python_api_name: qiskit.quantum_info.Statevector ### data - + Return data. ### dim - + Return total state dimension. @@ -244,7 +244,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -268,7 +268,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -375,7 +375,7 @@ python_api_name: qiskit.quantum_info.Statevector ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -503,7 +503,7 @@ python_api_name: qiskit.quantum_info.Statevector ### rtol - + The relative tolerance parameter for float comparisons. @@ -565,7 +565,7 @@ python_api_name: qiskit.quantum_info.Statevector ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -573,7 +573,7 @@ python_api_name: qiskit.quantum_info.Statevector ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.mdx index 9539793a6b3..b6959aa9cff 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring # qiskit.quantum\_info.Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -137,7 +137,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -183,13 +183,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -294,7 +294,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -328,7 +328,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -362,13 +362,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -376,7 +376,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.mdx index 3380df27e35..bcb5798508b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp # qiskit.quantum\_info.SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -131,7 +131,7 @@ $$ ### atol - + The default absolute tolerance parameter for float comparisons. @@ -177,13 +177,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -288,7 +288,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -322,7 +322,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -356,13 +356,13 @@ $$ ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. DEPRECATED: use operator.atol = value instead @@ -370,7 +370,7 @@ $$ ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. DEPRECATED: use operator.rtol = value instead diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index c13df54f8da..50b8ef90397 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # qiskit.quantum\_info.TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.24/qiskit.result.Counts.mdx b/docs/api/qiskit/0.24/qiskit.result.Counts.mdx index 2405e8fdc00..a0ae06b1fe1 100644 --- a/docs/api/qiskit/0.24/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.24/qiskit.result.Counts.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts # qiskit.result.Counts - + A class to store a counts result from a circuit execution. Build a counts object diff --git a/docs/api/qiskit/0.24/qiskit.result.Result.mdx b/docs/api/qiskit/0.24/qiskit.result.Result.mdx index 3cc5cafa99c..81bc4cf9324 100644 --- a/docs/api/qiskit/0.24/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.24/qiskit.result.Result.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result # qiskit.result.Result - + Model for Results. ### backend\_name @@ -126,7 +126,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.24/qiskit.result.ResultError.mdx index de54876cd22..9961e4d0b8c 100644 --- a/docs/api/qiskit/0.24/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.24/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.mdx index 0028ea12f07..68b70fa5140 100644 --- a/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # qiskit.scheduler.ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.mdx index 201691a98da..0a5c8b7743b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap # qiskit.transpiler.CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -128,25 +128,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. @@ -174,7 +174,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### is\_symmetric - + Test if the graph is symmetric. Return True if symmetric, False otherwise @@ -202,7 +202,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### physical\_qubits - + Returns a sorted list of physical\_qubits diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.mdx index 61d983f0ae5..b80e7464b6d 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # qiskit.transpiler.FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.mdx index 6d0201859a1..21db024d7c8 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # qiskit.transpiler.FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.mdx index 80c9407fb0c..1dd7593d191 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController # qiskit.transpiler.FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -39,7 +39,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.mdx index 0719fcf623e..62892514c0c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # qiskit.transpiler.InstructionDurations - + Helper class to provide durations of instructions for scheduling. It stores durations (gate lengths) and dt to be used at the scheduling stage of transpiling. It can be constructed from `backend` or `instruction_durations`, which is an argument of `transpile()`. @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.Layout.mdx index 0a244e395ee..a3f54c1e309 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.Layout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout # qiskit.transpiler.Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -137,7 +137,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -160,7 +160,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers in regs. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.mdx index efd55895326..122551bf722 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager # qiskit.transpiler.PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.mdx index 4380e7210a9..09856ded988 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # qiskit.transpiler.PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.mdx index 1e5d55bae34..d703d68eb6f 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet # qiskit.transpiler.PropertySet - + A default dictionary-like object ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.mdx index 11b2d005ff8..30c67e13062 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.mdx index 390c7e5b2cb..02df30179c6 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.mdx index 537b7284225..a2022b2fa77 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # qiskit.transpiler.passes.ALAPSchedule - + ALAP Scheduling. ALAPSchedule initializer. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.mdx index f441a3f3feb..7faa003cb0c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # qiskit.transpiler.passes.ASAPSchedule - + ASAP Scheduling. ASAPSchedule initializer. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.mdx index 40f5713bee7..e2e6a6f1e44 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # qiskit.transpiler.passes.ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 15c92b9f3c5..f7c393eee7a 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # qiskit.transpiler.passes.BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.mdx index d96bfcc1e2b..13b21c80525 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # qiskit.transpiler.passes.BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.mdx index 35f9fb9a8ae..20bc3938025 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # qiskit.transpiler.passes.BasisTranslator - + Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. This pass operates in several steps: @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.mdx index b8c1983a3d7..9b28f63d4c9 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # qiskit.transpiler.passes.CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.mdx index 5444a33511c..43213e49a04 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # qiskit.transpiler.passes.CXCancellation - + Cancel back-to-back cx gates in dag. ### \_\_init\_\_ @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.mdx index f344ade2229..74d3f056e20 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # qiskit.transpiler.passes.CXDirection - + Rearrange the direction of the cx nodes to match the directed coupling map. Flip the cx nodes to match the directed coupling map. This pass makes use of the following equivalence: @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.mdx index 3e726bb7ad2..d54de736b56 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # qiskit.transpiler.passes.CheckCXDirection - + Check if the CNOTs follow the right direction with respect to the coupling map. This pass checks if the CNOTs (or any other 2Q) in the DAG follow the right direction with respect to the coupling map. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.mdx index f5551162e1d..8542b474575 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # qiskit.transpiler.passes.CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.mdx index bb6f9cd0df7..f90692c253d 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # qiskit.transpiler.passes.Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to propert\_set as a dictionary of the form: @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.mdx index 68ed8f48d6a..d2dcc94323c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # qiskit.transpiler.passes.CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.mdx index ad94098e429..5dc8b2bad6d 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # qiskit.transpiler.passes.CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 607a1df93b0..0c304467420 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # qiskit.transpiler.passes.ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.mdx index 3fe28f504d0..2362c0f05cc 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # qiskit.transpiler.passes.CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.mdx index f0c1fa34ad8..cf5c0a4f4b3 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # qiskit.transpiler.passes.CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 4243be225a1..4bf4302b080 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # qiskit.transpiler.passes.CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. @@ -218,7 +218,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -232,7 +232,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.mdx index 4c3c385e1fd..b8c7da36cfd 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # qiskit.transpiler.passes.DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.mdx index 27bff29feb5..9e6eca6bca5 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # qiskit.transpiler.passes.DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ### \_\_init\_\_ @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.mdx index 975db306c03..0217e109469 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # qiskit.transpiler.passes.Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.mdx index 410f9d0da03..1130e71ca21 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # qiskit.transpiler.passes.DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.mdx index f84bc74fd04..3c7568b8fc0 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth # qiskit.transpiler.passes.Depth - + Calculate the depth of a DAG circuit. ### \_\_init\_\_ @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 36bf87d85b5..869e45d94d4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # qiskit.transpiler.passes.EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.mdx index 3951d7acdec..22bb7a3881c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # qiskit.transpiler.passes.FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 8a0dd7dfc3b..b1e2c058902 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # qiskit.transpiler.passes.FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.mdx index 736f1cdf2fd..398e611adb5 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # qiskit.transpiler.passes.Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.mdx index 3a2065ab1f9..b9dd11a2189 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # qiskit.transpiler.passes.LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index ee96f1c510a..59a979db4ba 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # qiskit.transpiler.passes.MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index d1a33daf2a8..f23437f8b49 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # qiskit.transpiler.passes.NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -82,7 +82,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.mdx index 736fe56c353..abe34d12f4e 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # qiskit.transpiler.passes.NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.mdx index 01ac84bdd86..45c07f42cec 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # qiskit.transpiler.passes.Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -106,7 +106,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 77225a67c29..e22e171419f 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # qiskit.transpiler.passes.Optimize1qGatesDecomposition - + Optimize chains of single-qubit gates by combining them into a single gate. Optimize1qGatesDecomposition initializer. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 00ebe363e12..22e6e929dbd 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 6a6ca691dec..5b361789dd4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # qiskit.transpiler.passes.RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index ca681acbbd6..46888592859 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # qiskit.transpiler.passes.RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ### \_\_init\_\_ @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.mdx index adcd69e3e2d..2edc1877310 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # qiskit.transpiler.passes.SabreLayout - + Choose a Layout via iterative bidirectional routing of the input circuit. Starting with a random initial Layout, the algorithm does a full routing of the circuit (via the routing\_pass method) to end up with a final\_layout. This final\_layout is then used as the initial\_layout for routing the reverse circuit. The algorithm iterates a number of times until it finds an initial\_layout that reduces full routing cost. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.mdx index 3a2f813ee56..81f8dcc1e7c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # qiskit.transpiler.passes.SabreSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of the SWAP-based heuristic search from the SABRE qubit mapping paper \[1] (Algorithm 1). The hueristic aims to minimize the number of lossy SWAPs inserted and the depth of the circuit. @@ -126,7 +126,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -134,7 +134,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.mdx index a73a19cc324..930b7baf790 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # qiskit.transpiler.passes.SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.mdx index f66163042b6..9b873acf313 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size # qiskit.transpiler.passes.Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.mdx index f9e69d83f48..cea7092579b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # qiskit.transpiler.passes.StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.mdx index 53a389ba3ac..2b45c4cf97a 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # qiskit.transpiler.passes.TemplateOptimization - + Class for the template optimization pass. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.mdx index 4edb04ffa9b..2df3bb97603 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # qiskit.transpiler.passes.TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.mdx index be540d1d82b..2dc881a7daa 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # qiskit.transpiler.passes.UnitarySynthesis - + Synthesize gates according to their basis gates. SynthesizeUnitaries initializer. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 069500672d3..93a80f6102e 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # qiskit.transpiler.passes.Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ### \_\_init\_\_ @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index c459c462556..724fa843804 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # qiskit.transpiler.passes.UnrollCustomDefinitions - + Unrolls instructions with custom definitions. Unrolls instructions with custom definitions. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.mdx index 6f64ea756b4..f975dbcacfb 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # qiskit.transpiler.passes.Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.mdx index e7590bfb4d2..3c20c4b0fa6 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width # qiskit.transpiler.passes.Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.mdx index cc71925b736..4333e764e42 100644 --- a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.mdx index 8f87fcfc332..b1826dee5cf 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.mdx b/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.mdx index 49ff393cd21..1ff27819bda 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.mdx +++ b/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.mdx @@ -25,7 +25,7 @@ Style sheets for pulse visualization. ### ComplexColors - + Create new instance of ComplexColors(real, imaginary) #### count @@ -36,7 +36,7 @@ Style sheets for pulse visualization. #### imaginary - + Alias for field number 1 @@ -50,14 +50,14 @@ Style sheets for pulse visualization. #### real - + Alias for field number 0 ### PulseStyle - + Style sheet for Qiskit-Pulse sample pulse drawer. Create new style sheet. @@ -76,7 +76,7 @@ Style sheets for pulse visualization. ### SchedStyle - + Style sheet for Qiskit-Pulse schedule drawer. Create new style sheet. @@ -127,12 +127,12 @@ Style sheets for pulse visualization. ### SchedTableColors - + Create new instance of SchedTableColors(time, channel, event) #### channel - + Alias for field number 1 @@ -144,7 +144,7 @@ Style sheets for pulse visualization. #### event - + Alias for field number 2 @@ -158,7 +158,7 @@ Style sheets for pulse visualization. #### time - + Alias for field number 0 diff --git a/docs/api/qiskit/0.25/logging.mdx b/docs/api/qiskit/0.25/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.25/logging.mdx +++ b/docs/api/qiskit/0.25/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.mdx index ced373b54da..7a1fd62186e 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.mdx index 9990867277d..74a6cdcbed6 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # qiskit.algorithms.AmplificationProblem - + The amplification problem is the input to amplitude amplification algorithms, like Grover. This class contains all problem-specific information required to run an amplitude amplification algorithm. It minimally contains the Grover operator. It can further hold some post processing on the optimal bitstring. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### is\_good\_state - + Check whether a provided bitstring is a good state or not. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### objective\_qubits - + The indices of the objective qubits. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### oracle - + Return the oracle. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### state\_preparation - + Get the state preparation operator $\mathcal{A}$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.mdx index ae78b99d326..6bc43ac06b0 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # qiskit.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -76,7 +76,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -101,7 +101,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** @@ -184,7 +184,7 @@ $$ ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.mdx index 831d8c595ce..61150b6a242 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # qiskit.algorithms.AmplitudeEstimationResult - + The `AmplitudeEstimation` result object. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### measurements - + Return the measurements as integers with their measurement probability. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle - + Return the MLE for the amplitude, in $\[0, 1]\$. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle\_processed - + Return the post-processed MLE for the amplitude. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_evaluation\_qubits - + Returns the number of evaluation qubits. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples - + Return the measurement samples with their measurement probability. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples\_processed - + Return the post-processed measurement samples with their measurement probability. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.mdx index 41de4a7b71b..f590f52119e 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # qiskit.algorithms.AmplitudeEstimator - + The Amplitude Estimation interface. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.mdx index c79948487f1..b4ca7246bcf 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # qiskit.algorithms.AmplitudeEstimatorResult - + The results object for amplitude estimation algorithms. ### \_\_init\_\_ @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.mdx index 75703feaa0d..97591d96c87 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # qiskit.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.mdx index 3c4d59fed31..6c46a5663d3 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # qiskit.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.mdx index a5fdcba53b2..bbf8f361d15 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # qiskit.algorithms.EstimationProblem - + The estimation problem is the input to amplitude estimation algorithm. This class contains all problem-specific information required to run an amplitude estimation algorithm. That means, it minimally contains the state preparation and the specification of the good state. It can further hold some post processing on the estimation of the amplitude or a custom Grover operator. @@ -52,7 +52,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### is\_good\_state - + Checks whether a bitstring represents a good state. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 45763fc1df3..1897fb4f7fd 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # qiskit.algorithms.FasterAmplitudeEstimation - + The Faster Amplitude Estimation algorithm. The Faster Amplitude Estimation (FAE) \[1] algorithm is a variant of Quantum Amplitude Estimation (QAE), where the Quantum Phase Estimation (QPE) by an iterative Grover search, similar to \[2]. @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index ba826fed8cc..6aa96221f17 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # qiskit.algorithms.FasterAmplitudeEstimationResult - + The result object for the Faster Amplitude Estimation algorithm. ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_first\_state\_steps - + Return the number of steps taken in the first step of algorithm. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_steps - + Return the total number of steps taken in the algorithm. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### success\_probability - + Return the success probability of the algorithm. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.Grover.mdx index 8a8ee0b22e3..acf51a042e9 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # qiskit.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -159,7 +159,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -178,7 +178,7 @@ $$ ### quantum\_instance - + Get the quantum instance. :rtype: `Optional`\[`QuantumInstance`] :returns: The quantum instance used to run this algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.mdx index 30550458714..f2db1318e6d 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # qiskit.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.GroverResult ### assignment - + The post-processed value of the most likely bitstring. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.GroverResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.GroverResult ### iterations - + All the powers of the Grover operator that have been tried. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.GroverResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.GroverResult ### oracle\_evaluation - + Whether the classical oracle evaluation of the top measurement was True or False. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.GroverResult ### top\_measurement - + The most frequently measured output as bitstring. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.HHL.mdx index df27335e92c..0a4b266d298 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # qiskit.algorithms.HHL - + 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. A system of linear equations is called $s$-sparse if $A$ has at most $s$ non-zero entries per row or column. Solving an $s$-sparse system of size $N$ with a classical computer requires $\mathcal{ O }(Ns\kappa\log(1/\epsilon))$ running time using the conjugate gradient method. Here $\kappa$ denotes the condition number of the system and $\epsilon$ the accuracy of the approximation. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.HHL ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.HHL ### quantum\_instance - + Get the quantum instance. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.HHL ### scaling - + The scaling of the solution vector. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index ade2cd90c7e..bfbb740e847 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # qiskit.algorithms.HamiltonianPhaseEstimation - + Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index f416f931b6e..61cb6ff02df 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # qiskit.algorithms.HamiltonianPhaseEstimationResult - + Store and manipulate results from running HamiltonianPhaseEstimation. This API of this class is nearly the same as PhaseEstimatorResult, differing only in the presence of an additional keyword argument in the methods. If scaled is False, then the phases are not translated and scaled to recover the eigenvalues of the Hamiltonian. Instead phi in $[0, 1)$ is returned, as is the case when then unitary is not derived from a Hamiltonian. @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_eigenvalue - + The most likely eigenvalue of the Hamiltonian. This method calls most\_likely\_phase and scales the result to obtain an eigenvalue. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_phase - + The most likely phase of the unitary corresponding to the Hamiltonian. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 090ee754a8c..79583ec9f0b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # qiskit.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### epsilon\_target - + Returns the target precision `epsilon_target` of the algorithm. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 385c82d1cc9..28a433a2dc1 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # qiskit.algorithms.IterativeAmplitudeEstimationResult - + The `IterativeAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### alpha - + Return the confidence level $\alpha$. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated - + Return the estimated half-width of the confidence interval. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated\_processed - + Return the post-processed estimated half-width of the confidence interval. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_target - + Return the target half-width of the confidence interval. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimate\_intervals - + Return the confidence intervals for the estimate in each iteration. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### powers - + Return the powers of the Grover operator in each iteration. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### ratios - + Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.mdx index d8a1825a82f..7aef2efe41f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # qiskit.algorithms.LinearSolver - + An abstract class for linear system solvers in Qiskit. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.mdx index da53deb9a45..f8028c4f5bc 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # qiskit.algorithms.LinearSolverResult - + A base class for linear systems results. The linear systems algorithms return an object of the type `LinearSystemsResult` with the information about the solution obtained. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### circuit\_results - + return the results from the circuits **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### euclidean\_norm - + return the euclidean norm if the algorithm knows how to calculate it **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### observable - + return the (list of) calculated observable(s) **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### state - + return either the circuit that prepares the solution or the solution as a vector **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c02655ea5b5..6acac4aa414 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -65,7 +65,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 0184cc3fc4d..685be864272 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + The `MaximumLikelihoodAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### evaluation\_schedule - + Return the evaluation schedule for the powers of the Grover operator. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### fisher\_information - + Return the Fisher information for the estimated amplitude. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### good\_counts - + Return the percentage of good counts per circuit power. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### minimizer - + Return the minimizer used for the search of the likelihood function. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### theta - + Return the estimate for the angle $\theta$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.mdx index f1edaaf58a1..c1e062c5420 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # qiskit.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.mdx index 228b97dc194..7e28b33e762 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # qiskit.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.mdx index 90fe56f19ab..97b777300bb 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # qiskit.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.mdx index cd454456bf9..ddbb4aa2e80 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # qiskit.algorithms.NumPyLinearSolver - + The Numpy Linear Solver algorithm (classical). This linear system solver computes the exact value of the given observable(s) or the full solution vector if no observable is specified. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 56110e2bd3d..e865a35ee25 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # qiskit.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.mdx index a03600dc287..08b4c38b96b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # qiskit.algorithms.PhaseEstimation - + Run the Quantum Phase Estimation (QPE) algorithm. This runs QPE with a multi-qubit register for reading the phases \[1] of input states. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.mdx index 84e91d4e94b..ae3df3f0dc6 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # qiskit.algorithms.PhaseEstimationResult - + Store and manipulate results from running PhaseEstimation. This class is instantiated by the PhaseEstimation class, not via user code. The PhaseEstimation class generates a list of phases and corresponding weights. Upon completion it returns the results as an instance of this class. The main method for accessing the results is filter\_phases. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### circuit\_result - + Return the result object returned by running the QPE circuit (on hardware or simulator). This is useful for inspecting and troubleshooting the QPE algorithm. @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### most\_likely\_phase - + Return the estimated phase as a number in $[0.0, 1.0)$. 1.0 corresponds to a phase of $2\pi$. It is assumed that the input vector is an eigenvector of the unitary so that the peak of the probability density occurs at the bit string that most closely approximates the true phase. @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### phases - + Return all phases and their frequencies computed by QPE. This is an array or dict whose values correspond to weights on bit strings. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.mdx index de8b5fe52b2..c4adc1fd63a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # qiskit.algorithms.PhaseEstimationScale - + Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. The `bound` is set when constructing this class. Then the method `scale` is used to find the factor by which to scale the operator. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### scale - + Return the Hamiltonian scaling factor. Return the scale factor by which a Hermitian operator must be multiplied so that the phase of the corresponding unitary is restricted to $[-\pi, \pi]$. This factor is computed from the bound on the absolute values of the eigenvalues of the operator. The methods `scale_phase` and `scale_phases` are used recover the eigenvalues corresponding the original (unscaled) Hermitian operator. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.mdx index 3da263a7e93..2522b7d9fef 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # qiskit.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.QAOA ### ansatz - + Returns the ansatz **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -314,13 +314,13 @@ python_api_name: qiskit.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.Shor.mdx index da7d0f79492..03796b7385f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # qiskit.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.mdx index dd2900a81c7..28195990185 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # qiskit.algorithms.ShorResult - + Shor Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.ShorResult ### factors - + returns factors **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.ShorResult ### successful\_counts - + returns successful counts **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.ShorResult ### total\_counts - + returns total counts **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.VQE.mdx index 77b26214c14..5fa6a80751b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # qiskit.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a quantum algorithm that uses a variational technique to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.VQE ### ansatz - + Returns the ansatz **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.algorithms.VQE ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.mdx index fc74e1e22c1..675814e2e5e 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # qiskit.algorithms.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.mdx index d7346c7e104..daab840bb70 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # qiskit.algorithms.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,67 +128,67 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -246,13 +246,13 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.mdx index fcb0a2f613b..964e41e9f92 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # qiskit.algorithms.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.mdx index 944643038d4..306552d8a39 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # qiskit.algorithms.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.mdx index 2fae01a4b4f..bcde425a455 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # qiskit.algorithms.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.mdx index 0c48de21807..3cd90f0363b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # qiskit.algorithms.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.mdx index c5ec1cdb5de..c51d642ba16 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # qiskit.algorithms.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 7cf901ff8a2..464d9d03db8 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # qiskit.algorithms.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.mdx index 4f7f71ce569..29ad20d828b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # qiskit.algorithms.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.mdx index 2a12f8e9418..3f40387487d 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # qiskit.algorithms.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -146,67 +146,67 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -338,13 +338,13 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.mdx index 70d5a6fd704..a8f17c14123 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # qiskit.algorithms.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.mdx index 4bcfd949f8b..eb30e1dbefe 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # qiskit.algorithms.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.mdx index e57f4129113..0085bc49ce9 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # qiskit.algorithms.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index f4f0c2c9618..cc917aa2ea2 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # qiskit.algorithms.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.mdx index c0fdb812a42..e6ac4b40930 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # qiskit.algorithms.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.mdx index 122975bb292..4022783ae9c 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # qiskit.algorithms.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 32eb1868947..fd14ed2b84b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # qiskit.algorithms.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.mdx index e43ba54fb81..664d301c356 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # qiskit.algorithms.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.mdx index 0e3cb6b9614..33547a16dd4 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # qiskit.algorithms.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.mdx index 122a5acebd2..7345f066bba 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # qiskit.algorithms.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.mdx index 448d7b75c14..f345b079737 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # qiskit.algorithms.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.mdx index 0293256115b..40414b7f195 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # qiskit.algorithms.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA \[1] is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -96,13 +96,13 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -151,7 +151,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -172,67 +172,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -286,13 +286,13 @@ $$ ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.mdx index 012053edb16..ae1dfb33859 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # qiskit.algorithms.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.25/qiskit.aqua.AquaError.mdx index cfb60f8d6da..b014309ee47 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.mdx index 537435976d9..ed6e75058c4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.mdx index 2915686d9f2..ba2584ac7ca 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # qiskit.aqua.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.aqua.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index fd56a255ecf..6a35fae521a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # qiskit.aqua.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -91,7 +91,7 @@ $$ ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -109,7 +109,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -161,7 +161,7 @@ $$ ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -177,7 +177,7 @@ $$ ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -219,7 +219,7 @@ $$ ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -251,7 +251,7 @@ $$ ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -273,7 +273,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -283,7 +283,7 @@ $$ ### random - + Return a numpy random. @@ -322,7 +322,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 5b9f724ff8a..873ab10b775 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult - + AmplitudeEstimationAlgorithm Result. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### a\_estimation - + return a\_estimation **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### estimation - + return estimation **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index de7e30b69ad..43e1456342e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # qiskit.aqua.algorithms.AmplitudeEstimationResult - + AmplitudeEstimation Result. ### \_\_init\_\_ @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_samples - + return a\_samples **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### circuit\_result - + return circuit result **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_a\_samples - + return mapped\_a\_samples **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_values - + return mapped\_values **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### max\_probability - + return max\_probability **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### ml\_value - + returns ml\_value **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mle - + return mle **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### probabilities - + return probabilities **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### shots - + return shots **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### y\_measurements - + return y\_measurements **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.mdx index ae4911c2635..44903b2aaf5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # qiskit.aqua.algorithms.BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index ba3f4257eed..80bf2b8b21c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # qiskit.aqua.algorithms.ClassicalAlgorithm - + Base class for Classical Algorithms. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index b99c7789762..fab4625a50d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # qiskit.aqua.algorithms.ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### random - + Return a numpy random. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### solution - + return solution diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.mdx index 61f63f2b650..01f87c17ba6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # qiskit.aqua.algorithms.DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.mdx index 0f903e2a1ae..045557279ff 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # qiskit.aqua.algorithms.EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.mdx index fb7faece3bf..547838264e3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # qiskit.aqua.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.mdx index 33c8bb26b35..9dfaf18e713 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # qiskit.aqua.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.mdx index 5f097a1b694..a8e75faf3b8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # qiskit.aqua.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -145,7 +145,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -174,7 +174,7 @@ $$ ### grover\_operator - + Returns grover\_operator. **Return type** @@ -202,7 +202,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -239,7 +239,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -249,7 +249,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.mdx index eff6a058332..9dcb420e0d8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # qiskit.aqua.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### assignment - + return assignment **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### circuit - + return circuit **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### measurement - + returns measurement **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### oracle\_evaluation - + return oracle evaluation **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### top\_measurement - + return top measurement **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.mdx index f7b3190b727..b4aaeccb6fe 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # qiskit.aqua.algorithms.HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -94,7 +94,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -122,7 +122,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -141,7 +141,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -160,7 +160,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** @@ -183,7 +183,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -193,7 +193,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.mdx index 3efe7dde0ae..e7382b96c50 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # qiskit.aqua.algorithms.HHLResult - + HHL Result. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### circuit\_info - + return circuit info **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### matrix - + return matrix **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### output - + return output **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### probability\_result - + return probability result **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### solution - + return solution **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### vector - + return vector **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.mdx index 959b84047b5..3dd5a16d8d2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # qiskit.aqua.algorithms.IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### random - + Return a numpy random. @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index d441266b937..85fba18f286 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # qiskit.aqua.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -166,7 +166,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -276,7 +276,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -286,7 +286,7 @@ $$ ### random - + Return a numpy random. @@ -325,7 +325,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index 5aa96c6cb2a..748d7af8f53 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult - + IterativeAmplitudeEstimation Result. ### \_\_init\_\_ @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_intervals - + return a\_intervals **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### actual\_epsilon - + return mle **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### alpha - + return alpha **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### powers - + return powers **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### ratios - + return ratios **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + return theta\_intervals **Return type** @@ -232,7 +232,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### value\_confidence\_interval - + return value\_confidence\_interval **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.mdx index fe9b12ced34..e630d32e5a5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # qiskit.aqua.algorithms.LinearsolverResult - + Linear solver Result. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 5956f87cf12..f7a68685d01 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -265,7 +265,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -275,7 +275,7 @@ $$ ### random - + Return a numpy random. @@ -314,7 +314,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 906324e009b..5b52cbed115 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + MaximumLikelihoodAmplitudeEstimation Result. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### a\_estimation - + return a\_estimation **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### circuit\_results - + return circuit results **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### confidence\_interval - + return confidence\_interval **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### estimation - + return estimation **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fisher\_information - + return fisher\_information **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### theta - + returns theta **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.mdx index b6c140be94f..8029dc3fd04 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # qiskit.aqua.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 2bde057521c..9d12d47da10 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # qiskit.aqua.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 3ef6ca0060a..e4e7dccc595 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # qiskit.aqua.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + Return the operator. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### random - + Return a numpy random. @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 4137b98fa34..ab6429e5780 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # qiskit.aqua.algorithms.NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 566acdf6ce2..2cd0965e0a8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # qiskit.aqua.algorithms.NumPyLSsolverResult - + Numpy LinearSystem Result. ### \_\_init\_\_ @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### eigvals - + return eigvals **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7d9471a3152..da3bb41909b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # qiskit.aqua.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### random - + Return a numpy random. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.mdx index 6db057482a9..9d457d3345b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # qiskit.aqua.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### random - + Return a numpy random. @@ -381,13 +381,13 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -403,7 +403,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.mdx index bde7b216d3e..a4640bfb4db 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # qiskit.aqua.algorithms.QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### d\_loss - + Returns discriminator loss **Return type** @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### discriminator - + Returns discriminator ### g\_loss - + Returns generator loss **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### generator - + Returns generator @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** @@ -154,13 +154,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### random - + Return a numpy random. ### rel\_entr - + Returns relative entropy between target and trained distribution **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### seed - + Returns random seed @@ -236,7 +236,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### tol\_rel\_ent - + Returns tolerance for relative entropy diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.mdx index 6c9e148847b..58d9d250342 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # qiskit.aqua.algorithms.QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### random - + Return a numpy random. @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.mdx index 32742d729af..26b863c939f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # qiskit.aqua.algorithms.QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### backend - + Returns backend. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** @@ -211,13 +211,13 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 8d7434818c7..8fff26c125c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # qiskit.aqua.algorithms.QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.mdx index 8a1addbcac2..aa0bdfe3ce4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # qiskit.aqua.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.mdx index 02fd7514957..52cee62018b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # qiskit.aqua.algorithms.Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.mdx index 8442c69cdc2..2b3cd189861 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # qiskit.aqua.algorithms.SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### class\_to\_label - + returns class to label ### label\_to\_class - + returns label to class @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.mdx index e407ef511ec..dd6068fd946 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # qiskit.aqua.algorithms.VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### class\_to\_label - + returns class to label @@ -161,13 +161,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### datapoints - + return data points ### feature\_map - + Return the feature map. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### label\_to\_class - + returns label to class @@ -261,13 +261,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -308,13 +308,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### random - + Return a numpy random. ### ret - + returns result @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### test\_dataset - + returns test dataset @@ -400,13 +400,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### training\_dataset - + returns training dataset ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.mdx index 5858de9ca78..3fa09a819db 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # qiskit.aqua.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -256,7 +256,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### random - + Return a numpy random. @@ -359,13 +359,13 @@ python_api_name: qiskit.aqua.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.mdx index b0b7def3bba..8f044e16bee 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # qiskit.aqua.circuits.CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.CNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.CNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.mdx index 60722895645..ed1b17ee960 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # qiskit.aqua.circuits.DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.DNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.DNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.mdx index 39accb7c113..dc04485582a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # qiskit.aqua.circuits.ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.ESOP ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.ESOP ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index fe33c11495f..a79c9488078 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # qiskit.aqua.circuits.PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### ancillary\_register - + returns ancillary register ### auxiliary\_register - + returns auxiliary register @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### state\_register - + returns state register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.mdx index c67dcb3cd56..a9d6dfe55ee 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # qiskit.aqua.circuits.StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.mdx index 5b275bb3535..263261e906a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # qiskit.aqua.circuits.WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -161,31 +161,31 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits ### num\_carry\_qubits - + returns num carry qubits ### num\_state\_qubits - + returns num state qubits ### num\_sum\_qubits - + returns num sum qubits ### num\_target\_qubits - + Returns the number of target qubits @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### weights - + returns weights diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.mdx index 570312bdb3b..c841ee04b7f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # qiskit.aqua.components.eigs.Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.mdx index 1d94727e0b7..a000ed40f95 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # qiskit.aqua.components.eigs.EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 4b489a699f9..b4939e34896 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # qiskit.aqua.components.feature\_maps.FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -58,31 +58,31 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index a9409dc9d07..4ca15fe4605 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # qiskit.aqua.components.feature\_maps.RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -69,31 +69,31 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.mdx index 6510698a98a..aff22f669fe 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # qiskit.aqua.components.initial\_states.Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.mdx index 1c371ffad98..8dcee7e91fb 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # qiskit.aqua.components.initial\_states.InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -34,11 +34,11 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### bitstr - + ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.mdx index 57a9002c711..509eca8b2e4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # qiskit.aqua.components.initial\_states.VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.mdx index b51ef7cc33e..cd6b622ed1f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # qiskit.aqua.components.initial\_states.Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 23d339ab751..a6cc6497dc0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # qiskit.aqua.components.multiclass\_extensions.AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index cd12c28cb2c..0d57860c84d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # qiskit.aqua.components.multiclass\_extensions.ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 2129162570a..bbdabbf6272 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # qiskit.aqua.components.multiclass\_extensions.MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index 33bb508dbbc..865bfb28bc6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # qiskit.aqua.components.multiclass\_extensions.OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index a45c778e813..2527bbad171 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # qiskit.aqua.components.neural\_networks.DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index f6cdba6d88e..73ee445876a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # qiskit.aqua.components.neural\_networks.GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### parameter\_values - + Get parameter values from the generator **Raises** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_discriminator - + Set discriminator network. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 40fb17633a9..f3848f3ef64 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # qiskit.aqua.components.neural\_networks.NumPyDiscriminator - + Discriminator based on NumPy **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 823ede5c275..0a05effe1d3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # qiskit.aqua.components.neural\_networks.PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index f732cfcf18a..4c2fae2b47c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # qiskit.aqua.components.neural\_networks.QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### discriminator - + Get discriminator. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### optimizer - + Get optimizer. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### parameter\_values - + Get parameter values from the quantum generator **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### seed - + Get seed. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.mdx index ef0b3809602..d543488872d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # qiskit.aqua.components.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.mdx index 0731c83bfb1..5f0039e33cf 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # qiskit.aqua.components.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,67 +130,67 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -248,13 +248,13 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.mdx index fd229abcf44..2fe30b6a348 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # qiskit.aqua.components.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.mdx index c5fd74e0b3d..55991c45ef6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # qiskit.aqua.components.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.mdx index 499e3a0dcc4..cf92c2aa1f5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # qiskit.aqua.components.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.mdx index 4038d116bc6..6af8a69bb30 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # qiskit.aqua.components.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8590001ac6e..c366c241344 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # qiskit.aqua.components.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 5604b313590..24b96919ef5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # qiskit.aqua.components.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.mdx index 469f5723bea..2104a1dfbb2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # qiskit.aqua.components.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.mdx index 333de2bed74..f5709158210 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # qiskit.aqua.components.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -127,7 +127,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -148,67 +148,67 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -340,13 +340,13 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.mdx index 397d9b5d42f..6189dd64722 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # qiskit.aqua.components.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.mdx index dba0fd9ba85..787d714a167 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # qiskit.aqua.components.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index c71bf7bd60b..48781e0581f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # qiskit.aqua.components.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index e6d33b5e282..135243451c7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # qiskit.aqua.components.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.mdx index 8227d7f2657..89bf21aadaf 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # qiskit.aqua.components.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.mdx index 0d1f3c01877..e9ac0f94c38 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # qiskit.aqua.components.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 275f472c907..bee2a0085c6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # qiskit.aqua.components.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.mdx index ad3ccd73021..560a4a48ac2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # qiskit.aqua.components.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.mdx index 0aea4556549..46f960acb37 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # qiskit.aqua.components.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.mdx index 7a58312796e..dbf3bd6ae15 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # qiskit.aqua.components.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.mdx index f3811b85da2..bdbe0897f01 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # qiskit.aqua.components.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.mdx index d9e1bb08faf..b1b4f2a2d4f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # qiskit.aqua.components.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -123,67 +123,67 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -237,13 +237,13 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.mdx index 597a684e2ba..e7fc949f6c2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # qiskit.aqua.components.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index e3942f76ec3..85caa6d3eb4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # qiskit.aqua.components.oracles.CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. @@ -69,13 +69,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -93,13 +93,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 3c4f757da7f..225d8475579 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # qiskit.aqua.components.oracles.LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -102,13 +102,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.mdx index 4115a2a9516..db9a3fc404d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # qiskit.aqua.components.oracles.Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -42,17 +42,17 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit - + Construct the oracle circuit. **Returns** @@ -62,13 +62,13 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b568f4c946e..6e67e33a39a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # qiskit.aqua.components.oracles.TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -90,13 +90,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.mdx index 12733381322..24685415d29 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # qiskit.aqua.components.reciprocals.LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.mdx index 81ea9c033da..417d4781447 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # qiskit.aqua.components.reciprocals.LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 557c97bc0a2..738b9c885b1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # qiskit.aqua.components.reciprocals.Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 6a50517d42c..27020a2a802 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # qiskit.aqua.components.uncertainty\_models.BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -142,35 +142,35 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### p - + ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### probabilities - + returns probabilities @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 22f28459568..21814d6362d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # qiskit.aqua.components.uncertainty\_models.GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### dimension - + returns dimensions @@ -158,49 +158,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 8d3315a2130..5f2b33ad2a4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # qiskit.aqua.components.uncertainty\_models.LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index c0b41887189..51fef3b7216 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # qiskit.aqua.components.uncertainty\_models.MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index eeb289bbe79..5b097bc040f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # qiskit.aqua.components.uncertainty\_models.MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 528b48c7586..23cf44e5f64 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # qiskit.aqua.components.uncertainty\_models.MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### dimension - + returns dimensions @@ -154,49 +154,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 830531fd516..51c9f5cc508 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index b3e63aba43e..b160ede9953 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # qiskit.aqua.components.uncertainty\_models.MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### dimension - + returns dimensions @@ -153,49 +153,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 46c3114ba4b..2dd748bb414 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # qiskit.aqua.components.uncertainty\_models.NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index e526ca3b43f..afbc8f9571e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # qiskit.aqua.components.uncertainty\_models.UncertaintyModel - + The abstract Uncertainty Model ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index 10ecbbbfbed..69cadc04f36 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # qiskit.aqua.components.uncertainty\_models.UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -141,31 +141,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### probabilities - + returns probabilities @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index 5a533bc58a2..316c48d150c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # qiskit.aqua.components.uncertainty\_models.UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -149,31 +149,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### probabilities - + returns probabilities @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index a364b9274d4..cc7e1006e8b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # qiskit.aqua.components.uncertainty\_models.UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -144,31 +144,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### probabilities - + returns probabilities @@ -217,7 +217,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### values - + returns values diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index 1c741bf2770..c6ab224913b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # qiskit.aqua.components.uncertainty\_problems.MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index 0e99e008c48..8c02d908cb8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # qiskit.aqua.components.uncertainty\_problems.UncertaintyProblem - + The abstract Uncertainty Problem component. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 5ac5955c5f7..0eeb0cb862f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # qiskit.aqua.components.uncertainty\_problems.UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: @@ -156,7 +156,7 @@ $$ ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index ccb460fb0f1..4b9b92d7e2a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # qiskit.aqua.components.uncertainty\_problems.UnivariateProblem - + Univariate uncertainty problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 0678df8bfc8..7007118837f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # qiskit.aqua.components.variational\_forms.VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### parameter\_bounds - + Parameter bounds. **Returns** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -116,11 +116,11 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.mdx index 4787352dbf8..bc4da1df0d2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.OperatorBase # qiskit.aqua.operators.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -177,7 +177,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -223,13 +223,13 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -315,7 +315,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -333,7 +333,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -353,7 +353,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 933592cb462..7ebc23253d9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # qiskit.aqua.operators.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.mdx index 5baddfcd2da..34fb0135015 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # qiskit.aqua.operators.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.mdx index 7d7dd8b170e..fa26b966c60 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # qiskit.aqua.operators.converters.ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index fc1aa54d7cf..a0e101f50fc 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # qiskit.aqua.operators.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 898ddc4fdb9..e7b77dd00f0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # qiskit.aqua.operators.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index a427ad49246..10782a3f3c5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # qiskit.aqua.operators.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index e463579330b..3e5ea422e91 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # qiskit.aqua.operators.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 6671c0f0f55..c828cc94cad 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # qiskit.aqua.operators.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -318,7 +318,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 286379421e5..d956a66efe0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # qiskit.aqua.operators.evolutions.MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index fe260118b9c..b33caa97fda 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # qiskit.aqua.operators.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.mdx index a777c872bc0..1493bf248e3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # qiskit.aqua.operators.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.mdx index ca0e463ca78..86b630b7026 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # qiskit.aqua.operators.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.mdx index f15b03435a4..480f6d58bd3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # qiskit.aqua.operators.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index cf919be5d48..361cbcf46fb 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # qiskit.aqua.operators.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 5e1f161079f..e69c3dedc31 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # qiskit.aqua.operators.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index 6999acf26ea..51f3206af90 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # qiskit.aqua.operators.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index 8e7df6d553f..4f5d780842c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # qiskit.aqua.operators.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 6c707d3988a..2f2707fcc05 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # qiskit.aqua.operators.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index f371ab0f386..dd297a5dfb3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # qiskit.aqua.operators.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index b2d0f7f4fc6..dcd55e48373 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # qiskit.aqua.operators.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.mdx index f4ae2b360d4..eaa155c0007 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # qiskit.aqua.operators.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a5ed172688b..7a8b5fd47e6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # qiskit.aqua.operators.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 8c3cd57f155..d49eded58c7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # qiskit.aqua.operators.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.mdx index cd28266e80e..f35162560af 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # qiskit.aqua.operators.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.mdx index 6ce8fd8a006..c14b662068b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # qiskit.aqua.operators.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.mdx index d565bbe49b5..7f41eb6829f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # qiskit.aqua.operators.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.mdx index 228cd12c85b..e8a0930eb53 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # qiskit.aqua.operators.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.mdx index 523cf619b37..f9876785c80 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # qiskit.aqua.operators.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.mdx index 29a31c4ad41..d32a409297e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # qiskit.aqua.operators.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.mdx index 7b013ca4d6e..da7ce1abd05 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # qiskit.aqua.operators.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parametrized quantum state, where QFI is: @@ -93,7 +93,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -112,7 +112,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.mdx index 613712d91a6..bfc269a4012 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # qiskit.aqua.operators.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parametrized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index c2f2beb55c0..bb98926c622 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # qiskit.aqua.operators.legacy.LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. ### \_\_init\_\_ - + Constructor. @@ -43,65 +43,65 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### basis - + returns basis ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### name - + returns name ### num\_qubits - + Returns number of qubits for operator ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 8cc914ff1bb..33e330bfa3c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # qiskit.aqua.operators.legacy.MatrixOperator - + Operators relevant for quantum applications @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### atol - + return atol ### basis - + returns basis @@ -131,13 +131,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### dense\_matrix - + Getter of matrix in dense matrix form. ### dia\_matrix - + diagonal matrix @@ -229,19 +229,19 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### matrix - + Getter of matrix. ### name - + returns name ### num\_qubits - + number of qubits required for the operator. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.mdx index 924e12d688d..5de75ef72ea 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # qiskit.aqua.operators.legacy.PauliGraph - + Pauli Graph. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph ### grouped\_paulis - + Getter of grouped Pauli list. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index e95b8cffdc7..b093ac18b44 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -108,13 +108,13 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -349,7 +349,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -368,7 +368,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -392,7 +392,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### grouping\_func - + returns grouping function @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### kwargs - + returns kwargs @@ -438,19 +438,19 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### name - + returns name ### num\_groups - + returns number of groups ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -464,7 +464,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### paulis - + get paulis @@ -539,7 +539,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -607,7 +607,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** @@ -625,7 +625,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 410f6d99cf1..1d422f494e1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # qiskit.aqua.operators.legacy.WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -99,13 +99,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -340,7 +340,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -415,13 +415,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### name - + returns name ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -435,7 +435,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### paulis - + get paulis @@ -559,7 +559,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index c2ef9da6c81..143a95207d0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # qiskit.aqua.operators.legacy.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. **Returns** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -139,19 +139,19 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -182,13 +182,13 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### tapering\_values - + returns tapering values ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 4e03fb5a52f..e7ce512e2c8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # qiskit.aqua.operators.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.mdx index c47867a18b2..0a7693ab4c3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # qiskit.aqua.operators.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.mdx index 2cdc1ee7d9e..1cc90a4070e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # qiskit.aqua.operators.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.mdx index e746124092a..eed67051ce7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # qiskit.aqua.operators.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index 6a491e3279f..3177f692897 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # qiskit.aqua.operators.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -324,7 +324,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index ba012dc5fb2..5a627740ba5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # qiskit.aqua.operators.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -328,7 +328,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index c43d201e415..931a3f988b1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # qiskit.aqua.operators.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -346,7 +346,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 83a54c620f2..838e7612f3d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # qiskit.aqua.operators.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index cefc082b6de..dfa6ef23fad 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # qiskit.aqua.operators.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index 0919f90636a..b1f641beaab 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # qiskit.aqua.operators.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.mdx index 81bf9c2c4ac..61dea24e238 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # qiskit.aqua.operators.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 440aea8d541..ebf15d8e7cc 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # qiskit.aqua.operators.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.mdx index 9aedab6571c..08d0478bb5a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # qiskit.aqua.operators.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -304,7 +304,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 1a99e0ab803..46eadd524ac 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # qiskit.aqua.operators.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.mdx index 063b279fc6e..46cbc653ae5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # qiskit.aqua.utils.CircuitFactory - + Base class for CircuitFactories ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.mdx index deb6f41b8aa..d7d143ad6ac 100644 --- a/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # qiskit.assembler.RunConfig - + Class for Run Configuration. ### shots @@ -97,7 +97,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.mdx index ae81b901aae..d49bcf65352 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # qiskit.chemistry.BosonicOperator - + A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.mdx index 556c2a3ff8d..707ca90e5f4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # qiskit.chemistry.FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: @@ -127,13 +127,13 @@ python_api_name: qiskit.chemistry.FermionicOperator ### h1 - + Getter of one body integral tensor. ### h2 - + Getter of two body integral tensor. @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.FermionicOperator ### modes - + Getter of modes. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.mdx index c2b377d45e7..fc1c0380536 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # qiskit.chemistry.MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_delta - + Get the MP2 delta energy correction for the molecule **Returns** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_energy - + Get the MP2 energy for the molecule **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.mdx index 14a734d0ea7..42d44f3c935 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # qiskit.chemistry.QMolecule - + Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.QMolecule ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.QMolecule ### filename - + returns temp file path @@ -96,13 +96,13 @@ python_api_name: qiskit.chemistry.QMolecule ### one\_body\_integrals - + Returns one body electron integrals. ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -157,13 +157,13 @@ python_api_name: qiskit.chemistry.QMolecule ### two\_body\_integrals - + Returns two body electron integrals. ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -186,7 +186,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -207,23 +207,23 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ### x\_dipole\_integrals - + returns x\_dipole\_integrals ### y\_dipole\_integrals - + returns y\_dipole\_integrals ### z\_dipole\_integrals - + returns z\_dipole\_integrals diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.mdx index 45da8572dcd..ccb0d52f7a2 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.mdx index 57c3baba265..4bb91464db2 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # qiskit.chemistry.WatsonHamiltonian - + Watson Hamiltonian class containing the results of a driver’s anharmonic calculation **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### data - + Returns the matrix elements of the Hamiltonian **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### num\_modes - + Returns the number of modes **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.mdx index 5712c6b1d7e..10d3766d08a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # qiskit.chemistry.algorithms.AdaptVQE - + A ground state calculation employing the AdaptVQE algorithm. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.mdx index c75a433cbe4..b004204cd19 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # qiskit.chemistry.algorithms.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 1686584e54e..8f837c70792 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # qiskit.chemistry.algorithms.EigensolverFactory - + A factory to construct a eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index 8d7068dcde7..c45e4b8bb74 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # qiskit.chemistry.algorithms.ExcitedStatesEigensolver - + The calculation of excited states via an Eigensolver algorithm **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 6f28d97e44f..c9d661eb9a5 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # qiskit.chemistry.algorithms.ExcitedStatesSolver - + The excited states calculation interface ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index 049d02842ec..31a09b74c85 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # qiskit.chemistry.algorithms.GroundStateEigensolver - + Ground state computation using a minimum eigensolver. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.mdx index a002dbd0c3e..e50c38a15a1 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # qiskit.chemistry.algorithms.GroundStateSolver - + The ground state calculation interface **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index b8a0edc1c32..5d10457f982 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # qiskit.chemistry.algorithms.MinimumEigensolverFactory - + A factory to construct a minimum eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index bbd3a1ddb68..5f614a46726 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # qiskit.chemistry.algorithms.NumPyEigensolverFactory - + A factory to construct a NumPyEigensolver. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### k - + returns k (number of eigenvalues requested) **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index a4bf14b44a3..fefb70f9093 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory - + A factory to construct a NumPyMinimumEigensolver. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index e5528c63fe3..e8d5c65a150 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # qiskit.chemistry.algorithms.OrbitalOptimizationVQE - + A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.mdx index 155c7f29498..b19172b381e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # qiskit.chemistry.algorithms.QEOM - + The calculation of excited states via the qEOM algorithm **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM ### excitations - + Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.mdx index c99651d042d..f7ac0463f6b 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # qiskit.chemistry.algorithms.QEomEE - + QEomEE algorithm (classical) **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### random - + Return a numpy random. @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.mdx index e429ecb926b..36ba3a7482f 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # qiskit.chemistry.algorithms.QEomVQE - + QEomVQE algorithm **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### random - + Return a numpy random. @@ -371,13 +371,13 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -393,7 +393,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.mdx index c49597fb26e..84fcedb1479 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # qiskit.chemistry.algorithms.VQEAdapt - + DEPRECATED. The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -166,13 +166,13 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -182,7 +182,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### random - + Return a numpy random. @@ -231,7 +231,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 28a0bb2ea8a..336e3102f39 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # qiskit.chemistry.algorithms.VQEUCCSDFactory - + A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### excitation\_type - + Getter of the `excitation_type` setting for the `excitation_type` setting. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_doubles - + Getter of the `method_doubles` setting for the `method_doubles` setting. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_singles - + Getter of the `method_singles` setting for the `method_singles` setting. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### same\_spin\_doubles - + Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index 56ad20a7469..544678a0c18 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # qiskit.chemistry.algorithms.VQEUVCCSDFactory - + A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 443eed81800..42d93c09387 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # qiskit.chemistry.algorithms.pes\_samplers.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index 65d0d472d1e..8b778a0d359 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # qiskit.chemistry.algorithms.pes\_samplers.DifferentialExtrapolator - + An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. Constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 84212db2c03..76fbb133fae 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # qiskit.chemistry.algorithms.pes\_samplers.EnergySurface1DSpline - + A simple cubic spline interpolation for the potential energy surface. A spline interpolation method for data fitting. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 3e97db2bc4f..d4ffd4621d7 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # qiskit.chemistry.algorithms.pes\_samplers.EnergySurfaceBase - + Class to hold a potential energy surface ### \_\_init\_\_ @@ -30,7 +30,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 84a5c18de02..9165093f82e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # qiskit.chemistry.algorithms.pes\_samplers.Extrapolator - + This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. Each instance of an Extrapolator requires a dictionary where each item consist of a point (key) and a list of variational parameters (value) for that given point. In practice, a Sampler Class can utilize the Extrapolator as a wrapper. The Extrapolator class then extracts optimal variational parameters from the previous points for use in extrapolation. For instance, one can utilize the Extrapolator to accelerate the computation of the Born-Oppenheimer Potential Energy Surface (BOPES) for a given molecule. In this case, each point can represent the interatomic distance and the list of parameters represent rotational parameters in a quantum circuit, in the context of computing the bond dissociation profile for a diatomic molecule. NOTE: However this is not a requirement - once an instance of the Extrapolator class is created, extrapolation can proceed by specifying the point(s) of interest and the dictionary of (point, parameter) pairs for a problem. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index 641fc6c3308..7a703d8b595 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # qiskit.chemistry.algorithms.pes\_samplers.HarmonicPotential - + Implements a 1D Harmonic potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + **Mostly for internal use. Preprocesses the data passed to fit\_to\_data()** so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 6197220d86a..141f6d4b0b6 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # qiskit.chemistry.algorithms.pes\_samplers.MorsePotential - + Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 44468f8e352..67e8ca8a7b3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PCAExtrapolator - + A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. Constructor. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index 337b214f283..3de1b074082 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PolynomialExtrapolator - + An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 953d1ee37a0..0250897ea92 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # qiskit.chemistry.algorithms.pes\_samplers.PotentialBase - + Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index 3c67abc8f76..202958a6a30 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.SieveExtrapolator - + A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. Constructor. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index 002af5ea244..ec3bc4b8640 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # qiskit.chemistry.algorithms.pes\_samplers.VibronicStructureBase - + Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 650f2acfed1..0f7dd5c2eee 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.WindowExtrapolator - + An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. Constructor. @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### extrapolator - + Returns the internal extrapolator. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### window - + Returns the size of the window. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index 34e4da3f0c4..c8581e90b98 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # qiskit.chemistry.applications.MolecularGroundStateEnergy - + Molecular ground state energy chemistry application **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### driver - + Returns chemistry driver **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### solver - + Returns minimum eigen solver **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 89111f7e7a3..1c4e110e046 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # qiskit.chemistry.components.bosonic\_bases.BosonicBasis - + Basis to express a second quantization Bosonic Hamiltonian. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 4f35286f61f..dab39d88a4e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # qiskit.chemistry.components.bosonic\_bases.HarmonicBasis - + Basis in which the Watson Hamiltonian is expressed. This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) as a modal basis for the expression of the Watson Hamiltonian or any bosonic operator. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0a607b86123..a4fc9327b76 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # qiskit.chemistry.components.initial\_states.HartreeFock - + A Hartree-Fock initial state. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.mdx index 3573ece0570..a9ea53953b9 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # qiskit.chemistry.components.initial\_states.VSCF - + Initial state for vibrational modes. Creates an occupation number vector as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. e.g. for 2 modes with 4 modals per mode it creates: |1000 1000> @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.mdx index 721e5653143..96e4629a59c 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # qiskit.chemistry.components.variational\_forms.CHC - + This trial wavefunction is the Compact Heuristic for Chemistry. The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. It aims at approximating the UCC Ansatz for a lower CNOT count. @@ -86,13 +86,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -142,11 +142,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.mdx index 59b6ee0d9ff..fed06dc156b 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # qiskit.chemistry.components.variational\_forms.UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -209,13 +209,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### double\_excitations - + Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] ### excitation\_pool - + Returns the full list of available excitations (called the pool). **Return type** @@ -225,13 +225,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -275,7 +275,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### parameter\_bounds - + Parameter bounds. **Returns** @@ -342,7 +342,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -358,7 +358,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -382,17 +382,17 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### setting - + ### single\_excitations - + Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.mdx index b1374beb072..788145ce31e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # qiskit.chemistry.components.variational\_forms.UVCC - + This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -126,13 +126,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -182,11 +182,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -200,7 +200,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.mdx index e1aeaf92671..0dcfe95e6e0 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,12 +8,12 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # qiskit.chemistry.core.ChemistryOperator - + Base class for ChemistryOperator. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### molecule\_info - + returns molecule info @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.mdx index 8843e492624..00d4ae27ad0 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # qiskit.chemistry.core.Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### molecule\_info - + returns molecule info diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.mdx index 2f3b74c1c13..9960bbe4a4a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # qiskit.chemistry.core.MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 74542543f4b..9fb56ed0560 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # qiskit.chemistry.core.MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 3beb168f157..30c91adb960 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # qiskit.chemistry.core.MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.mdx index e4a1697a231..a9aff48d83a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # qiskit.chemistry.core.QubitMappingType - + QubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.mdx index 262ec05ebbc..58368e87694 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # qiskit.chemistry.core.TransformationType - + Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.mdx index ac19637363a..91e8c384daa 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # qiskit.chemistry.drivers.BaseDriver - + Base class for Qiskit’s chemistry drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### basis - + return basis **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### molecule - + return molecule **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.mdx index df886e5eab1..5d6330f8ca0 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # qiskit.chemistry.drivers.BasisType - + Basis Type ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.mdx index 48b7a932af8..eea5be18efe 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # qiskit.chemistry.drivers.BosonicDriver - + Base class for Qiskit’s chemistry bosonic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 2ac2ff37113..64af52d8b37 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # qiskit.chemistry.drivers.FCIDumpDriver - + Qiskit chemistry driver reading an FCIDump file. The FCIDump format is partially defined in Knowles1989. @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### basis - + return basis **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### molecule - + return molecule **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.mdx index 9698b0ba2e4..41f39e2dcac 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # qiskit.chemistry.drivers.FermionicDriver - + Base class for Qiskit’s chemistry fermionic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.mdx index 9ce181344d5..4b83193d6b3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # qiskit.chemistry.drivers.GaussianDriver - + Qiskit chemistry driver using the Gaussian™ 16 program. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index cd7ea2d7d8f..08d46359fff 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # qiskit.chemistry.drivers.GaussianForcesDriver - + Gaussian™ 16 forces driver. **Parameters** @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 9d606b4ad1b..e36dbee06aa 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # qiskit.chemistry.drivers.GaussianLogDriver - + Gaussian™ 16 log driver. Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.mdx index 4d3c5a5ce94..7ee96b06672 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # qiskit.chemistry.drivers.GaussianLogResult - + Result for Gaussian™ 16 log driver. This result allows access to selected data from the log file that is not available via the use Gaussian 16 interfacing code when using the MatrixElement file. Since this parses the text output it is subject to the format of the log file. @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### a\_to\_h\_numbering - + A to H numbering mapping. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### cubic\_force\_constants - + Cubic force constants. (3 indices, 3 values) **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### log - + The complete Gaussian log in the form of a list of strings. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quadratic\_force\_constants - + Quadratic force constants. (2 indices, 3 values) **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quartic\_force\_constants - + Quartic force constants. (4 indices, 3 values) **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.mdx index 3cefebe757f..948e73faea3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # qiskit.chemistry.drivers.HDF5Driver - + Qiskit chemistry driver reading an HDF5 file. The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### basis - + return basis **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### molecule - + return molecule **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### work\_path - + Returns work path. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.mdx index 36c88a55523..7af31402def 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # qiskit.chemistry.drivers.HFMethodType - + HFMethodType Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.mdx index b3623aea87e..099eda4e94f 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # qiskit.chemistry.drivers.InitialGuess - + Initial Guess Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.mdx index 4736dcd3c34..adde40ac520 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # qiskit.chemistry.drivers.Molecule - + Driver-independent Molecule definition. This module implements an interface for a driver-independent, i.e. generic molecule definition. It defines the composing atoms (with properties like masses), and allows for changing the molecular geometry through given degrees of freedom (e.g. bond-stretching, angle-bending, etc.). The geometry as provided in the constructor can be affected, through setting perturbations, and it is this perturbed geometry that is supplied by the geometry getter. Setting perturbations to None will cause the original geometry to be returned, and there is a getter to get this value directly if its needed. @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### charge - + Get charge **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### geometry - + Get geometry accounting for any perturbations **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### masses - + Get masses **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### multiplicity - + Get multiplicity **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### perturbations - + Get perturbations **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -206,7 +206,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) @@ -224,7 +224,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### units - + The geometry coordinate units diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.mdx index 3fb20d1d394..bd018fbd6f3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # qiskit.chemistry.drivers.PSI4Driver - + Qiskit chemistry driver using the PSI4 program. See [http://www.psicode.org/](http://www.psicode.org/) @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.mdx index b2106147207..423d3eabda9 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # qiskit.chemistry.drivers.PyQuanteDriver - + Qiskit chemistry driver using the PyQuante2 library. See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante2) @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### basis - + return basis **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### molecule - + return molecule **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.mdx index 29b4d848a11..24879916fd1 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # qiskit.chemistry.drivers.PySCFDriver - + Qiskit chemistry driver using the PySCF library. See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### basis - + return basis **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### molecule - + return molecule **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.mdx index f9fa0412ddf..83a3a911c16 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # qiskit.chemistry.drivers.UnitsType - + Units Type Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.mdx index 36205b5512a..a786749378f 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # qiskit.chemistry.results.BOPESSamplerResult - + The BOPES Sampler result Creates an new instance of the result. :type points: `List`\[`float`] :param points: List of points. :type energies: `List`\[`float`] :param energies: List of energies. :type raw\_results: `Dict`\[`float`, `EigenstateResult`] :param raw\_results: Raw results obtained from the solver. @@ -36,7 +36,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### energies - + returns list of energies. **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### points - + returns list of points. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### raw\_results - + returns all results for all points. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.mdx index 954cc118e43..12f2c70edb4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # qiskit.chemistry.results.EigenstateResult - + The eigenstate result interface. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenenergies - + returns eigen energies **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenstates - + returns eigen states **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundenergy - + returns ground energy **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundstate - + returns ground state **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.mdx index da8d5298511..c3e8534fcb4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # qiskit.chemistry.results.ElectronicStructureResult - + The electronic structure result. ### \_\_init\_\_ @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_energies - + Returns electronic part of ground state energy **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundstate - + returns ground state **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### magnetization - + Returns measured magnetization **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### num\_particles - + Returns measured number of particles **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -376,7 +376,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### spin - + Returns computed spin **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -396,7 +396,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** @@ -416,7 +416,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_energies - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.mdx index a887eb829fe..c41c7b869cf 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # qiskit.chemistry.results.VibronicStructureResult - + The vibronic structure result. ### \_\_init\_\_ @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### computed\_vibronic\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundstate - + returns ground state **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### num\_occupied\_modals\_per\_mode - + Returns the number of occupied modal per mode **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 92a08ff1be8..f43a2851888 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # qiskit.chemistry.transformations.BosonicQubitMappingType - + BosonicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.mdx index 10ae059df90..2106cb09a1a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # qiskit.chemistry.transformations.BosonicTransformation - + A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### basis - + returns the basis (number of modals per mode) **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### num\_modes - + the number of modes **Type** @@ -147,7 +147,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.mdx index 3fcffefe2ae..c30b6fb37ef 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # qiskit.chemistry.transformations.BosonicTransformationType - + BosonicTransformationType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index fd03b5106aa..ffde0817035 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # qiskit.chemistry.transformations.FermionicQubitMappingType - + FermionicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.mdx index b1c59782d78..d35778e2310 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # qiskit.chemistry.transformations.FermionicTransformation - + A transformation from a fermionic problem, represented by a driver, to a qubit operator. **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### molecule\_info - + Getter of the molecule information. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### qubit\_mapping - + Getter of the qubit mapping. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.mdx index ccd64026ceb..440aa1e271c 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # qiskit.chemistry.transformations.FermionicTransformationType - + Electronic Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.mdx index 169b0076a07..dae4e6f83d6 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # qiskit.chemistry.transformations.Transformation - + Base class for transformation to qubit operators for chemistry problems ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.mdx index 0b0ae623073..b3281422238 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # qiskit.circuit.AncillaQubit - + A qubit used as ancillary qubit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.AncillaQubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.mdx index c6971c51192..eb116e3822d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # qiskit.circuit.AncillaRegister - + Implement an ancilla register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.mdx index 0f0b3c1169f..6e040f63c60 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # qiskit.circuit.ClassicalRegister - + Implement a classical register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Clbit.mdx index b4c5ce884ae..c9d9a550d63 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # qiskit.circuit.Clbit - + Implement a classical bit. Creates a classical bit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Clbit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.mdx index f67a23e0354..7091f6ed192 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # qiskit.circuit.ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -324,13 +324,13 @@ python_api_name: qiskit.circuit.ControlledGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.ControlledGate ### duration - + Get the duration. @@ -362,7 +362,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return gate label **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.circuit.ControlledGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.ControlledGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.ControlledGate ### params - + Get parameters from base\_gate. **Returns** @@ -540,7 +540,7 @@ python_api_name: qiskit.circuit.ControlledGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Delay.mdx index 7f711f95e1b..3143ff8d521 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # qiskit.circuit.Delay - + Do nothing and just delay/wait/idle for a specified duration. Create new delay instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Delay ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration of this delay. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.Delay ### params - + return instruction params. @@ -240,7 +240,7 @@ python_api_name: qiskit.circuit.Delay ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.mdx index 00f71e10fbe..132c39310f7 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # qiskit.circuit.EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Gate.mdx index 67be8b2a688..3464948ed55 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # qiskit.circuit.Gate - + Unitary gate. Create a new gate. @@ -187,19 +187,19 @@ python_api_name: qiskit.circuit.Gate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return gate label **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.circuit.Gate ### params - + return instruction params. @@ -371,7 +371,7 @@ python_api_name: qiskit.circuit.Gate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Instruction.mdx index 4014dc71d70..53b83c3b99c 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # qiskit.circuit.Instruction - + Generic quantum instruction. Create a new instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.circuit.Instruction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.Instruction ### params - + return instruction params. @@ -267,7 +267,7 @@ python_api_name: qiskit.circuit.Instruction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.mdx index 3cd05f0003e..b3ad228266e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # qiskit.circuit.InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Measure.mdx index e4ebf16f584..3f5840d2486 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # qiskit.circuit.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Parameter.mdx index 806e44c059a..9b1c2d7d91e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # qiskit.circuit.Parameter - + Parameter Class for variable parameters. Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). @@ -166,13 +166,13 @@ python_api_name: qiskit.circuit.Parameter ### name - + Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.mdx index 0c123d87771..7535c0371b9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # qiskit.circuit.ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). @@ -171,7 +171,7 @@ python_api_name: qiskit.circuit.ParameterExpression ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.mdx index 1f89d746816..8c9ee0b0bbb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # qiskit.circuit.ParameterVector - + ParameterVector class to quickly generate lists of parameters. ### \_\_init\_\_ @@ -40,13 +40,13 @@ python_api_name: qiskit.circuit.ParameterVector ### name - + Returns the name of the ParameterVector. ### params - + Returns the list of parameters in the ParameterVector. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.mdx index 01603d95c28..0a28f32588c 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # qiskit.circuit.QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -323,7 +323,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -482,7 +482,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -492,7 +492,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -528,19 +528,19 @@ python_api_name: qiskit.circuit.QuantumCircuit ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -758,7 +758,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### data - + Return the circuit data (instructions and context). **Returns** @@ -971,7 +971,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -989,7 +989,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1007,7 +1007,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### global\_phase - + Return the global phase of the circuit in radians. @@ -1420,7 +1420,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1434,13 +1434,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1472,13 +1472,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1506,7 +1506,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1653,7 +1653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.mdx index 06b8f372671..427b50414e5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # qiskit.circuit.QuantumRegister - + Implement a quantum register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Qubit.mdx index 8f18a4b8a5b..9c1d1c5eb6a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # qiskit.circuit.Qubit - + Implement a quantum bit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Qubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.25/qiskit.circuit.Reset.mdx index dab23df6ede..d5e4389b4ac 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # qiskit.circuit.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 6d7b7af0269..844b59e8d23 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # qiskit.circuit.classicalfunction.BooleanExpression - + The Boolean Expression gate. **Parameters** @@ -190,25 +190,25 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### label - + Return gate label **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### params - + return instruction params. @@ -432,7 +432,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 7b3676d0dae..1546e2d239e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # qiskit.circuit.classicalfunction.ClassicalFunction - + Represent a classical function function and its logic network. Creates a `ClassicalFunction` from Python source code in `source`. @@ -94,7 +94,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### args - + Returns the classicalfunction arguments @@ -219,19 +219,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### label - + Return gate label **Return type** @@ -291,13 +291,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### network - + Returns the logical network ### params - + return instruction params. @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### qregs - + The list of qregs used by the classicalfunction @@ -379,7 +379,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### scopes - + Returns the scope dict @@ -476,13 +476,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### truth\_table - + Returns (and computes) the truth table ### types - + Dumps a list of scopes with their variables and types. **Returns** @@ -496,7 +496,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4e8d89a0540..06ac2b44dce 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 440d4532159..b13f84a2a7f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.AND.mdx index 76cb786c4d2..78af5e41d0d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # qiskit.circuit.library.AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.AND ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.AND ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.AND ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.AND ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.AND ### global\_phase - + Return the global phase of the circuit in radians. @@ -1335,7 +1335,7 @@ python_api_name: qiskit.circuit.library.AND ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1349,13 +1349,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1387,13 +1387,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1421,7 +1421,7 @@ python_api_name: qiskit.circuit.library.AND ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1568,7 +1568,7 @@ python_api_name: qiskit.circuit.library.AND ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.mdx index f04f40eeaca..ae107288303 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # qiskit.circuit.library.Barrier - + Barrier instruction. Create new barrier instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Barrier ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.library.Barrier ### params - + return instruction params. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.Barrier ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.mdx index 9fcd4dc4048..df0585a6fe5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # qiskit.circuit.library.C3SXGate - + The 3-qubit controlled sqrt-X gate. This implementation is based on Page 17 of \[1]. @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -204,13 +204,13 @@ python_api_name: qiskit.circuit.library.C3SXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### params - + Get parameters from base\_gate. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.mdx index b71a6f73b86..e232348a667 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # qiskit.circuit.library.C3XGate - + The 4-qubit controlled X gate. This implementation uses $\sqrt{T}$ and 14 CNOT gates. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.C3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### duration - + Get the duration. @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return gate label **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### params - + Get parameters from base\_gate. **Returns** @@ -396,7 +396,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.mdx index f214afe8823..5c5cfda9906 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # qiskit.circuit.library.C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1], with the use of the relative phase version of c3x, the rc3x \[2]. @@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -188,13 +188,13 @@ python_api_name: qiskit.circuit.library.C4XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### params - + Get parameters from base\_gate. **Returns** @@ -400,7 +400,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.mdx index 658a6a6b86a..199f906c493 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # qiskit.circuit.library.CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** @@ -228,7 +228,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -238,13 +238,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -254,7 +254,7 @@ $$ ### duration - + Get the duration. @@ -272,7 +272,7 @@ $$ ### label - + Return gate label **Return type** @@ -298,7 +298,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -312,7 +312,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -326,7 +326,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -450,7 +450,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.mdx index 3d83e02c772..862287fd647 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # qiskit.circuit.library.CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. @@ -223,7 +223,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -233,13 +233,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -249,7 +249,7 @@ $$ ### duration - + Get the duration. @@ -267,7 +267,7 @@ $$ ### label - + Return gate label **Return type** @@ -293,7 +293,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -307,7 +307,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -321,7 +321,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -445,7 +445,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.mdx index 287c7b6c362..a874a477ab4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # qiskit.circuit.library.CPhaseGate - + Controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.mdx index 6dd6abd6b7b..8d5e3a9223c 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # qiskit.circuit.library.CRXGate - + Controlled-RX gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.mdx index 85560f7ec9b..33b08027b5d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # qiskit.circuit.library.CRYGate - + Controlled-RY gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.mdx index 820c2d7c629..f0212271a13 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # qiskit.circuit.library.CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -226,7 +226,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -236,13 +236,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -252,7 +252,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.mdx index 7b80f2d7f0b..a208b522311 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # qiskit.circuit.library.CSXGate - + Controlled-√X gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -268,7 +268,7 @@ $$ ### label - + Return gate label **Return type** @@ -294,7 +294,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -308,7 +308,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -322,7 +322,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -446,7 +446,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.mdx index d46ee153681..98c5fee02e2 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # qiskit.circuit.library.CSwapGate - + Controlled-X gate. **Circuit symbol:** @@ -239,7 +239,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -249,13 +249,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -265,7 +265,7 @@ $$ ### duration - + Get the duration. @@ -283,7 +283,7 @@ $$ ### label - + Return gate label **Return type** @@ -309,7 +309,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -323,7 +323,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -337,7 +337,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -461,7 +461,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.mdx index f27051341f6..569fe5db52e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # qiskit.circuit.library.CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.mdx index 33793c4aa91..4d8756ed06d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # qiskit.circuit.library.CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.mdx index 34768816364..f7f98793b8f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # qiskit.circuit.library.CUGate - + Controlled-U gate (4-parameter two-qubit gate). This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $e^{i\gamma}$ of the U gate. @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.mdx index 1da615ebb22..70cb1ed00f3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # qiskit.circuit.library.CXGate - + Controlled-X gate. **Circuit symbol:** @@ -222,7 +222,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -232,13 +232,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -248,7 +248,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return gate label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.mdx index 8ea7e3f1d76..64b9235ed47 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # qiskit.circuit.library.CYGate - + Controlled-Y gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.mdx index 8d0a179fd86..927190ee3f8 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # qiskit.circuit.library.CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. @@ -201,7 +201,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -211,13 +211,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -227,7 +227,7 @@ $$ ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -285,7 +285,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -299,7 +299,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.mdx index 116bae511b8..bdd4156ad90 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # qiskit.circuit.library.DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. @@ -195,19 +195,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.mdx index 4d6dab10c37..881c8c12fc4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # qiskit.circuit.library.Diagonal - + Diagonal circuit. Circuit symbol: @@ -272,7 +272,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -431,7 +431,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -441,7 +441,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -477,19 +477,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -707,7 +707,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1369,7 +1369,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1383,13 +1383,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1421,13 +1421,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1455,7 +1455,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1602,7 +1602,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.mdx index 774d6497e43..b214acf5abf 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # qiskit.circuit.library.ECRGate - + An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). This gate is maximally entangling and is equivalent to a CNOT up to single-qubit pre-rotations. The echoing procedure mitigates some unwanted terms (terms other than ZX) to cancel in an experiment. @@ -219,19 +219,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ $$ ### label - + Return gate label **Return type** @@ -291,7 +291,7 @@ $$ ### params - + return instruction params. @@ -391,7 +391,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.mdx index 9934c3fbce1..aa5ca06aa85 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # qiskit.circuit.library.EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + Return the circuit data (instructions and context). **Returns** @@ -872,7 +872,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### global\_phase - + Return the global phase of the circuit in radians. @@ -1040,7 +1040,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1170,7 +1170,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1433,7 +1433,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1447,13 +1447,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1509,7 +1509,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1529,7 +1529,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1559,7 +1559,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1609,7 +1609,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1720,7 +1720,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qregs - + A list of the quantum registers associated with the circuit. @@ -1794,7 +1794,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1856,7 +1856,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1962,7 +1962,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.mdx index 176e127bb0b..01c8c4e1c60 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # qiskit.circuit.library.ExcitationPreserving - + The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -355,7 +355,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -909,7 +909,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -955,7 +955,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1015,7 +1015,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1063,7 +1063,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1193,7 +1193,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1456,7 +1456,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1470,13 +1470,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1500,7 +1500,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1522,7 +1522,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1532,7 +1532,7 @@ $$ ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1552,7 +1552,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1582,7 +1582,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1618,7 +1618,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1632,7 +1632,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1673,7 +1673,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1743,7 +1743,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1817,7 +1817,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1879,7 +1879,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1985,7 +1985,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.mdx index a027f1aefbd..fa7d9134cf9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # qiskit.circuit.library.FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.FourierChecking ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### data - + Return the circuit data (instructions and context). **Returns** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -940,7 +940,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### global\_phase - + Return the global phase of the circuit in radians. @@ -1353,7 +1353,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1367,13 +1367,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1405,13 +1405,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1439,7 +1439,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.mdx index a24ffcf6a04..e13e697324f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # qiskit.circuit.library.FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -369,7 +369,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,7 +1363,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1377,13 +1377,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1425,13 +1425,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1467,7 +1467,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1550,7 +1550,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qregs - + A list of the quantum registers associated with the circuit. @@ -1624,7 +1624,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.mdx index 807af3745e0..0eb6adf9266 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # qiskit.circuit.library.GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -259,7 +259,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -418,7 +418,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -428,7 +428,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -464,19 +464,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -943,7 +943,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1356,7 +1356,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1370,13 +1370,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1408,13 +1408,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1442,7 +1442,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1589,7 +1589,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GR.mdx index c4d3475ee78..39dbb9e6fa4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # qiskit.circuit.library.GR - + Global R gate. **Circuit symbol:** @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.mdx index 621718bb5dc..a0b91976cfa 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # qiskit.circuit.library.GRX - + Global RX gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.mdx index 6f9fd9289d0..5d9a864c622 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # qiskit.circuit.library.GRY - + Global RY gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.mdx index 3647378902e..d3867cb3840 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # qiskit.circuit.library.GRZ - + Global RZ gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.mdx index b15f6732b00..08d8703de7a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # qiskit.circuit.library.GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -262,7 +262,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -421,7 +421,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -431,7 +431,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -467,19 +467,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -697,7 +697,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -910,7 +910,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -928,7 +928,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1359,7 +1359,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1373,13 +1373,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1411,13 +1411,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1445,7 +1445,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1592,7 +1592,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.mdx index 0b87380fe9f..584e1cb96e6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # qiskit.circuit.library.GroverOperator - + The Grover operator. Grover’s search algorithm \[1, 2] consists of repeated applications of the so-called Grover operator used to amplify the amplitudes of the desired output states. This operator, $\mathcal{Q}$, consists of the phase oracle, $\mathcal{S}_f$, zero phase-shift or zero reflection, $\mathcal{S}_0$, and an input state preparation $\mathcal{A}$: @@ -369,7 +369,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -528,7 +528,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -538,7 +538,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -574,19 +574,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -804,7 +804,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1017,7 +1017,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1035,7 +1035,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1053,7 +1053,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1466,7 +1466,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1480,13 +1480,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1518,13 +1518,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1546,7 +1546,7 @@ $$ ### oracle - + The oracle implementing a reflection about the bad state. @@ -1558,7 +1558,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1705,7 +1705,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1729,7 +1729,7 @@ $$ ### reflection\_qubits - + Reflection qubits, on which S0 is applied (if S0 is not user-specified). @@ -2601,7 +2601,7 @@ $$ ### state\_preparation - + The subcircuit implementing the A operator or Hadamards. **Return type** @@ -2902,7 +2902,7 @@ $$ ### zero\_reflection - + The subcircuit implementing the reflection about 0. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.mdx index 51a7c2399ba..f281bf88e40 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # qiskit.circuit.library.HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -221,7 +221,7 @@ $$ ### label - + Return gate label **Return type** @@ -247,7 +247,7 @@ $$ ### params - + return instruction params. @@ -359,7 +359,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.mdx index 5e744bddc9a..8e50b400d78 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # qiskit.circuit.library.HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.mdx index 00642ce66cc..9ee7a4ee743 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # qiskit.circuit.library.IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.mdx index 6e4a200c697..f7be4515079 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # qiskit.circuit.library.IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.IQP ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.IQP ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.IQP ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.IQP ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.IQP ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.IQP ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.IQP ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.IQP ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.mdx index 210d12c384e..579127752d0 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # qiskit.circuit.library.InnerProduct - + An n\_qubit circuit that computes the inner product of two registers. Return a circuit to compute the inner product of 2 n-qubit registers. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -395,7 +395,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -405,7 +405,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -441,19 +441,19 @@ python_api_name: qiskit.circuit.library.InnerProduct ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -671,7 +671,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### data - + Return the circuit data (instructions and context). **Returns** @@ -884,7 +884,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -902,7 +902,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,7 +1333,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1347,13 +1347,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1385,13 +1385,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1419,7 +1419,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1566,7 +1566,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.mdx index 8c7f1fe5c7a..7532c66d2bf 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # qiskit.circuit.library.IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on the parameter `geq`): @@ -247,7 +247,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -406,7 +406,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -416,7 +416,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -452,19 +452,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -682,7 +682,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -913,7 +913,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -931,7 +931,7 @@ $$ ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -945,7 +945,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1358,7 +1358,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1372,19 +1372,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1416,7 +1416,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1426,13 +1426,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -1468,7 +1468,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1551,7 +1551,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1625,7 +1625,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2774,7 +2774,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 8abfb5bae81..1f5e6f2b533 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # qiskit.circuit.library.LinearAmplitudeFunction - + A circuit implementing a (piecewise) linear function on qubit amplitudes. An amplitude function $F$ of a function $f$ is a mapping @@ -282,7 +282,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -441,7 +441,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -451,7 +451,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -487,19 +487,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -717,7 +717,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1379,7 +1379,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1393,13 +1393,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,13 +1431,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1465,7 +1465,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1630,7 +1630,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.mdx index 42109cd50ca..0af911f7a7f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # qiskit.circuit.library.LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -927,7 +927,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -945,7 +945,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -963,7 +963,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,7 +1390,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1404,13 +1404,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1442,7 +1442,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1452,13 +1452,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1488,7 +1488,7 @@ $$ ### offset - + The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. @@ -1510,7 +1510,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1593,7 +1593,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1667,7 +1667,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2366,7 +2366,7 @@ $$ ### slope - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.mdx index b8e86503199..2c9a61d5c7a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # qiskit.circuit.library.LogNormalDistribution - + A circuit to encode a discretized log-normal distribution in qubit amplitudes. A random variable $X$ is log-normal distributed if @@ -281,7 +281,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -440,7 +440,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -450,7 +450,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -460,7 +460,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -496,19 +496,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -726,7 +726,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -939,7 +939,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1388,7 +1388,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1402,13 +1402,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1440,13 +1440,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1474,7 +1474,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1511,7 +1511,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1631,7 +1631,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2780,7 +2780,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.mdx index 1d80fc06cd1..d062d5f3a1f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # qiskit.circuit.library.MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as: @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.MCMT ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.MCMT ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -467,19 +467,19 @@ python_api_name: qiskit.circuit.library.MCMT ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -679,7 +679,7 @@ python_api_name: qiskit.circuit.library.MCMT ### data - + Return the circuit data (instructions and context). **Returns** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -910,7 +910,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -928,7 +928,7 @@ python_api_name: qiskit.circuit.library.MCMT ### global\_phase - + Return the global phase of the circuit in radians. @@ -1301,7 +1301,7 @@ python_api_name: qiskit.circuit.library.MCMT ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1315,19 +1315,19 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_ancilla\_qubits - + Return the number of ancillas. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1393,7 +1393,7 @@ python_api_name: qiskit.circuit.library.MCMT ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1540,7 +1540,7 @@ python_api_name: qiskit.circuit.library.MCMT ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.mdx index 0fc13de5693..626e183dd03 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # qiskit.circuit.library.MCMTVChain - + The MCMT implementation using the CCX V-chain. This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -443,7 +443,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -453,7 +453,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -489,19 +489,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### data - + Return the circuit data (instructions and context). **Returns** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### global\_phase - + Return the global phase of the circuit in radians. @@ -1323,7 +1323,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1337,19 +1337,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_ancilla\_qubits - + Return the number of ancilla qubits required. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1381,13 +1381,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1562,7 +1562,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.mdx index 8ff6f6a2f0c..95094eee33f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # qiskit.circuit.library.MCPhaseGate - + Multi-controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the state of the control qubits. @@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -201,13 +201,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### duration - + Get the duration. @@ -235,7 +235,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### label - + Return gate label **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### params - + Get parameters from base\_gate. **Returns** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.mdx index 5f63d0f905d..197ad249388 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # qiskit.circuit.library.MCXGate - + The general, multi-controlled X gate. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.mdx index b59f372d7e8..71e449a2e93 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # qiskit.circuit.library.MCXGrayCode - + Implement the multi-controlled X gate using the Gray code. This delegates the implementation to the MCU1 gate, since $X = H \cdot U1(\pi) \cdot H$. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -228,7 +228,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### label - + Return gate label **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -268,13 +268,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### params - + Get parameters from base\_gate. **Returns** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.mdx index dc5130be5b3..81dd6bb49a5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # qiskit.circuit.library.MCXRecursive - + Implement the multi-controlled X gate using recursion. Using a single ancilla qubit, the multi-controlled X gate is recursively split onto four sub-registers. This is done until we reach the 3- or 4-controlled X gate since for these we have a concrete implementation that do not require ancillas. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.mdx index 3df8b84511b..1c8afedd6c5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # qiskit.circuit.library.MCXVChain - + Implement the multi-controlled X gate using a V-chain of CX gates. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### label - + Return gate label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -264,13 +264,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### params - + Get parameters from base\_gate. **Returns** @@ -408,7 +408,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.mdx index 5729c3ab6e5..240441ef2ea 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # qiskit.circuit.library.MSGate - + MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. Global Mølmer–Sørensen gate. @@ -179,19 +179,19 @@ python_api_name: qiskit.circuit.library.MSGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return gate label **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.circuit.library.MSGate ### params - + return instruction params. @@ -363,7 +363,7 @@ python_api_name: qiskit.circuit.library.MSGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.mdx index 9d3017dbe0b..afb38644b4e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # qiskit.circuit.library.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.mdx index 23ec1ca7727..d88e8cb71ee 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # qiskit.circuit.library.NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -334,7 +334,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.NLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ python_api_name: qiskit.circuit.library.NLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -874,7 +874,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.library.NLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1062,7 +1062,7 @@ python_api_name: qiskit.circuit.library.NLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1192,7 +1192,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1455,7 +1455,7 @@ python_api_name: qiskit.circuit.library.NLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1469,13 +1469,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1551,7 +1551,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1581,7 +1581,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1617,7 +1617,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1672,7 +1672,7 @@ python_api_name: qiskit.circuit.library.NLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1742,7 +1742,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1816,7 +1816,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1878,7 +1878,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1984,7 +1984,7 @@ python_api_name: qiskit.circuit.library.NLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.mdx index bbd23470189..658a630a834 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # qiskit.circuit.library.NormalDistribution - + A circuit to encode a discretized normal distribution in qubit amplitudes. The probability density function of the normal distribution is defined as @@ -329,7 +329,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -488,7 +488,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -498,7 +498,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -508,7 +508,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -544,19 +544,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -774,7 +774,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -987,7 +987,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1005,7 +1005,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1023,7 +1023,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1436,7 +1436,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1450,13 +1450,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1488,13 +1488,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1522,7 +1522,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1559,7 +1559,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1679,7 +1679,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2828,7 +2828,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.OR.mdx index 63345acaca1..666fedf021a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # qiskit.circuit.library.OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.OR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.OR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.OR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.OR ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.OR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1335,7 +1335,7 @@ python_api_name: qiskit.circuit.library.OR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1349,13 +1349,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1387,13 +1387,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1421,7 +1421,7 @@ python_api_name: qiskit.circuit.library.OR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1568,7 +1568,7 @@ python_api_name: qiskit.circuit.library.OR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.mdx index 4f4f277c3bc..cca2181a720 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # qiskit.circuit.library.PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -364,7 +364,7 @@ $$ ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -378,7 +378,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -461,7 +461,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -471,7 +471,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -507,19 +507,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -918,7 +918,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -932,7 +932,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -968,7 +968,7 @@ $$ ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -988,7 +988,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1006,7 +1006,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1068,7 +1068,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1116,7 +1116,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1246,7 +1246,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1509,7 +1509,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1523,13 +1523,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1553,7 +1553,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1575,7 +1575,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1585,13 +1585,13 @@ $$ ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1621,7 +1621,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1657,7 +1657,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1671,7 +1671,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1738,7 +1738,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1808,7 +1808,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1882,7 +1882,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1944,7 +1944,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2050,7 +2050,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.mdx index 0ffdf75d6ce..8714547651a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # qiskit.circuit.library.PauliTwoDesign - + The Pauli Two-Design ansatz. This class implements a particular form of a 2-design circuit \[1], which is frequently studied in quantum machine learning literature, such as e.g. the investigating of Barren plateaus in variational algorithms \[2]. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### data - + Return the circuit data (instructions and context). **Returns** @@ -854,7 +854,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement - + Get the entanglement strategy. **Return type** @@ -868,7 +868,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### global\_phase - + Return the global phase of the circuit in radians. @@ -1022,7 +1022,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1152,7 +1152,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1429,13 +1429,13 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1459,7 +1459,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1491,7 +1491,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters\_settable - + Return the number of settable parameters. **Return type** @@ -1505,7 +1505,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1535,7 +1535,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1571,7 +1571,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1626,7 +1626,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1696,7 +1696,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qregs - + A list of the quantum registers associated with the circuit. @@ -1770,7 +1770,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1832,7 +1832,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1938,7 +1938,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.mdx index d9060558135..ca377a7a73f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # qiskit.circuit.library.Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.Permutation ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.Permutation ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.Permutation ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.Permutation ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.Permutation ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.Permutation ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.Permutation ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.Permutation ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.mdx index d55c6855fab..b4c46fd49f2 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # qiskit.circuit.library.PhaseEstimation - + Phase Estimation circuit. In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.mdx index 70612ae3d38..60776a8b265 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # qiskit.circuit.library.PhaseGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -213,19 +213,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### params - + return instruction params. @@ -381,7 +381,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.mdx index 011ce98811b..259c442ae30 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # qiskit.circuit.library.PhaseOracle - + Phase Oracle. The Phase Oracle object constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR). as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) & (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -972,7 +972,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### global\_phase - + Return the global phase of the circuit in radians. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1399,13 +1399,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1437,13 +1437,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1471,7 +1471,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1618,7 +1618,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.mdx index f9a40bab4f0..d82c1b0d824 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # qiskit.circuit.library.PiecewiseChebyshev - + Piecewise Chebyshev approximation to an input function. For a given function $f(x)$ and degree $d$, this class implements a piecewise polynomial Chebyshev approximation on $n$ qubits to $f(x)$ on the given intervals. All the polynomials in the approximation are of degree $d$. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### breakpoints - + The breakpoints for the piecewise approximation. **Return type** @@ -438,7 +438,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### data - + Return the circuit data (instructions and context). **Returns** @@ -750,7 +750,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### degree - + The degree of the polynomials. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### f\_x - + The function to be approximated. **Return type** @@ -955,7 +955,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -991,7 +991,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### global\_phase - + Return the global phase of the circuit in radians. @@ -1404,7 +1404,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1418,13 +1418,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1456,7 +1456,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1466,13 +1466,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1508,7 +1508,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1524,7 +1524,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### polynomials - + The polynomials for the piecewise approximation. **Return type** @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qregs - + A list of the quantum registers associated with the circuit. @@ -1679,7 +1679,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 6a7584d8543..1c753b6eda2 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # qiskit.circuit.library.PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -260,7 +260,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -393,7 +393,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -435,7 +435,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -447,7 +447,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -457,7 +457,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -493,19 +493,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -595,7 +595,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -968,7 +968,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -986,7 +986,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1004,7 +1004,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1272,7 +1272,7 @@ $$ ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -1286,7 +1286,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -1445,7 +1445,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1459,19 +1459,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1503,7 +1503,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1513,13 +1513,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1549,7 +1549,7 @@ $$ ### offsets - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -1567,7 +1567,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1724,7 +1724,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2423,7 +2423,7 @@ $$ ### slopes - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 8c1dd89534a..ceda663f704 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # qiskit.circuit.library.PiecewisePolynomialPauliRotations - + Piecewise-polynomially-controlled Pauli rotations. This class implements a piecewise polynomial (not necessarily continuous) function, $f(x)$, on qubit amplitudes, which is defined through breakpoints and coefficients as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding coefficients by $[a_{j,1},...,a_{j,d}]$, where $d$ is the highest degree among all polynomials. @@ -303,7 +303,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -436,7 +436,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -478,7 +478,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise polynomial function. The function is polynomial in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -494,7 +494,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -504,7 +504,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -540,19 +540,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -564,7 +564,7 @@ $$ ### coeffs - + The coefficients of the polynomials. **Return type** @@ -656,7 +656,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -798,7 +798,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1029,7 +1029,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1047,7 +1047,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1065,7 +1065,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,7 +1333,7 @@ $$ ### mapped\_coeffs - + The coefficients mapped to the internal representation, since we only compare x>=breakpoint. **Return type** @@ -1492,7 +1492,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1506,7 +1506,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1520,13 +1520,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1558,7 +1558,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1568,13 +1568,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1610,7 +1610,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1693,7 +1693,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1767,7 +1767,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.mdx index 40d4e0f9403..a04f8f2cedc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # qiskit.circuit.library.PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -508,7 +508,7 @@ $$ ### coeffs - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. @@ -730,7 +730,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -766,7 +766,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -993,7 +993,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1406,7 +1406,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1420,19 +1420,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1464,7 +1464,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1474,13 +1474,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1516,7 +1516,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1599,7 +1599,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1673,7 +1673,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1741,7 +1741,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.mdx index b857b73b28c..1aa75fc0d5d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # qiskit.circuit.library.QAOAAnsatz - + A generalized QAOA quantum circuit with a support of custom initial states and mixers. **References** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -403,7 +403,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -449,19 +449,19 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -593,7 +593,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cost\_operator - + Returns an operator representing the cost of the optimization problem. **Returns** @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### data - + Return the circuit data (instructions and context). **Returns** @@ -906,7 +906,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -924,7 +924,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### global\_phase - + Return the global phase of the circuit in radians. @@ -990,7 +990,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### initial\_state - + Returns an optional initial state as a circuit **Return type** @@ -1365,7 +1365,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1373,7 +1373,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### mixer\_operator - + Returns an optional mixer operator expressed as an operator or a quantum circuit. **Returns** @@ -1393,13 +1393,13 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1441,7 +1441,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_qubits - + Return number of qubits. @@ -1469,7 +1469,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameter\_bounds - + Parameter bounds. **Returns: A list of pairs indicating the bounds, as (lower, upper). None indicates** @@ -1483,7 +1483,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1570,7 +1570,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qregs - + A list of the quantum registers associated with the circuit. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### reps - + Returns the reps parameter, which determines the depth of the circuit. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.mdx index e887879e991..81170d37f59 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # qiskit.circuit.library.QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -259,7 +259,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -290,7 +290,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -432,7 +432,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -442,7 +442,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -478,19 +478,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -708,7 +708,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -811,7 +811,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -953,7 +953,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -971,7 +971,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1135,7 +1135,7 @@ $$ ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -1380,7 +1380,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1394,13 +1394,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1432,7 +1432,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1442,7 +1442,7 @@ $$ ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -1482,7 +1482,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1565,7 +1565,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1639,7 +1639,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.mdx index 76d11a395c2..47e9423182e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # qiskit.circuit.library.QuadraticForm - + Implements a quadratic form on binary variables encoded in qubit registers. A quadratic form on binary variables is a quadratic function $Q$ acting on a binary variable of $n$ bits, $x = x_0 ... x_{n-1}$. For an integer matrix $A$, an integer vector $b$ and an integer $c$ the function can be written as @@ -269,7 +269,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -428,7 +428,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -438,7 +438,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -474,19 +474,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -704,7 +704,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -917,7 +917,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -953,7 +953,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1366,7 +1366,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1380,13 +1380,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1418,13 +1418,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1452,7 +1452,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1599,7 +1599,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1661,7 +1661,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.mdx index c46cfc8618f..db718912ec1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # qiskit.circuit.library.QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -453,19 +453,19 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -683,7 +683,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### data - + Return the circuit data (instructions and context). **Returns** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### global\_phase - + Return the global phase of the circuit in radians. @@ -1345,7 +1345,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1397,13 +1397,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.mdx index ee957425994..a1e1aa5d622 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # qiskit.circuit.library.RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RC3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.mdx index fdcaf70dc5e..d08b8ae8071 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # qiskit.circuit.library.RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RCCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.mdx index 95fa41f9b46..2e95ae4fee8 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # qiskit.circuit.library.RGate - + Rotation θ around the cos(φ)x + sin(φ)y axis. **Circuit symbol:** @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ $$ ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ $$ ### params - + return instruction params. @@ -361,7 +361,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.mdx index 4753fbf526a..724a8c3c5ab 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # qiskit.circuit.library.RVGate - + Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. **Circuit symbol:** @@ -207,19 +207,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -363,7 +363,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.mdx index 30836f4c33b..0adeaeab97d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # qiskit.circuit.library.RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.mdx index 05daf903c31..bb620977c24 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # qiskit.circuit.library.RXXGate - + A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.mdx index 3f32c8fabd2..a384f4039a6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # qiskit.circuit.library.RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.mdx index d0ec9e70219..eb937897cb2 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # qiskit.circuit.library.RYYGate - + A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.mdx index 524cbec7ead..e8f4b7c69a6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # qiskit.circuit.library.RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -231,7 +231,7 @@ $$ ### label - + Return gate label **Return type** @@ -257,7 +257,7 @@ $$ ### params - + return instruction params. @@ -369,7 +369,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.mdx index 33e46ce5819..488055eebb9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # qiskit.circuit.library.RZXGate - + A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. @@ -255,19 +255,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -285,7 +285,7 @@ $$ ### label - + Return gate label **Return type** @@ -311,7 +311,7 @@ $$ ### params - + return instruction params. @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.mdx index 41e21c373d6..0104ab8d23a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # qiskit.circuit.library.RZZGate - + A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -229,19 +229,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -259,7 +259,7 @@ $$ ### label - + Return gate label **Return type** @@ -285,7 +285,7 @@ $$ ### params - + return instruction params. @@ -397,7 +397,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.mdx index 5e6f2f0948e..813bd945f6b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # qiskit.circuit.library.RealAmplitudes - + The real-amplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. It is called `RealAmplitudes` since the prepared quantum states will only have real amplitudes, the complex part is always 0. @@ -359,7 +359,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -718,7 +718,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + Return the circuit data (instructions and context). **Returns** @@ -899,7 +899,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -913,7 +913,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -959,7 +959,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -977,7 +977,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1019,7 +1019,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### global\_phase - + Return the global phase of the circuit in radians. @@ -1067,7 +1067,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1197,7 +1197,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1460,7 +1460,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1474,13 +1474,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1504,7 +1504,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1536,7 +1536,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1556,7 +1556,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1622,7 +1622,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1636,7 +1636,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1677,7 +1677,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1747,7 +1747,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qregs - + A list of the quantum registers associated with the circuit. @@ -1821,7 +1821,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1883,7 +1883,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1989,7 +1989,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.mdx index e61eae070dd..1fa473d5474 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # qiskit.circuit.library.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.mdx index e681efc0e5d..20c11843bcc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # qiskit.circuit.library.SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.mdx index 31e2ca561e0..5e3e7644c3c 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # qiskit.circuit.library.SXGate - + The single-qubit Sqrt(X) gate ($\sqrt{X}$). **Matrix Representation:** @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -230,7 +230,7 @@ $$ ### label - + Return gate label **Return type** @@ -256,7 +256,7 @@ $$ ### params - + return instruction params. @@ -368,7 +368,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.mdx index d2a244f6d0b..d07c7691d51 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # qiskit.circuit.library.SXdgGate - + The inverse single-qubit Sqrt(X) gate. $$ @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.mdx index bbb9b3538d1..e55985c7c78 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # qiskit.circuit.library.SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.mdx index ee9a970ad95..2f3dfcb4adb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # qiskit.circuit.library.SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -229,7 +229,7 @@ $$ ### label - + Return gate label **Return type** @@ -255,7 +255,7 @@ $$ ### params - + return instruction params. @@ -367,7 +367,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.mdx index 1a154ec3844..debdfc447aa 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # qiskit.circuit.library.TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.mdx index 3728c913051..b977e816f7a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # qiskit.circuit.library.TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.mdx index 3a7f643274e..9a89431cfee 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # qiskit.circuit.library.TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -381,7 +381,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -464,7 +464,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -474,7 +474,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -510,19 +510,19 @@ python_api_name: qiskit.circuit.library.TwoLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -740,7 +740,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -921,7 +921,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -981,7 +981,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1041,7 +1041,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1089,7 +1089,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1219,7 +1219,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1482,7 +1482,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1496,13 +1496,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1548,7 +1548,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1558,7 +1558,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1608,7 +1608,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1658,7 +1658,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1769,7 +1769,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1843,7 +1843,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1905,7 +1905,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2011,7 +2011,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.mdx index 1779ea7ff0e..974868d6f58 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # qiskit.circuit.library.U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -215,19 +215,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### params - + return instruction params. @@ -383,7 +383,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.mdx index ec6ce49d431..f900cabbae9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # qiskit.circuit.library.U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.mdx index 0988c3006d0..e1bd2b609fc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # qiskit.circuit.library.U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.mdx index 03bcceb0a06..3d48c7831a1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # qiskit.circuit.library.UGate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.mdx index de75dbd174a..c842c43c16a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # qiskit.circuit.library.UniformDistribution - + A circuit to encode a discretized uniform distribution in qubit amplitudes. This simply corresponds to applying Hadamard gates on all qubits. @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.mdx index 74c48bea873..4c1a4ea0a87 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # qiskit.circuit.library.WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -280,7 +280,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -439,7 +439,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -449,7 +449,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -485,19 +485,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -715,7 +715,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -928,7 +928,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1377,7 +1377,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1391,7 +1391,7 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. **Return type** @@ -1401,13 +1401,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_carry\_qubits - + The number of carry qubits required to compute the sum. Note that this is not necessarily equal to the number of ancilla qubits, these can be queried using `num_ancilla_qubits`. @@ -1423,7 +1423,7 @@ $$ ### num\_clbits - + Return number of classical bits. @@ -1447,7 +1447,7 @@ $$ ### num\_control\_qubits - + The number of additional control qubits required. Note that the total number of ancilla qubits can be obtained by calling the method `num_ancilla_qubits`. @@ -1471,7 +1471,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1481,13 +1481,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -1501,7 +1501,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -1537,7 +1537,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1620,7 +1620,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1694,7 +1694,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2843,7 +2843,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.mdx index 98d71f568f5..3484e52657d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # qiskit.circuit.library.XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.mdx index 581638ab573..13c680a3695 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # qiskit.circuit.library.XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.XOR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.XOR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -453,19 +453,19 @@ python_api_name: qiskit.circuit.library.XOR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -683,7 +683,7 @@ python_api_name: qiskit.circuit.library.XOR ### data - + Return the circuit data (instructions and context). **Returns** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.XOR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1345,7 +1345,7 @@ python_api_name: qiskit.circuit.library.XOR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1397,13 +1397,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.XOR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.XOR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.mdx index 674193a1560..32233bb718d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # qiskit.circuit.library.YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.mdx index 652bbbb5f83..b4414b46c2e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # qiskit.circuit.library.ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -439,7 +439,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -475,19 +475,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -705,7 +705,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1036,7 +1036,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1084,7 +1084,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1214,7 +1214,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1491,13 +1491,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1543,7 +1543,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1553,13 +1553,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1589,7 +1589,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1625,7 +1625,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1639,7 +1639,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1667,7 +1667,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1776,7 +1776,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1850,7 +1850,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1912,7 +1912,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2018,7 +2018,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.mdx index ee60248a181..af04e29e3cb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # qiskit.circuit.library.ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.mdx index cf34834e8c4..5d2f654b90d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # qiskit.circuit.library.ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -328,7 +328,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -471,19 +471,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -882,7 +882,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -970,7 +970,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1032,7 +1032,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1080,7 +1080,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1210,7 +1210,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1473,7 +1473,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1487,13 +1487,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1517,7 +1517,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1539,7 +1539,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1549,13 +1549,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1621,7 +1621,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1635,7 +1635,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1663,7 +1663,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1702,7 +1702,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1772,7 +1772,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1846,7 +1846,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1908,7 +1908,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2014,7 +2014,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.mdx index b1172f7de65..690f475c910 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # qiskit.circuit.library.iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. @@ -224,19 +224,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### params - + return instruction params. @@ -408,7 +408,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.mdx index 3676f602c6f..c4c872cb726 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # qiskit.dagcircuit.DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. @@ -201,7 +201,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -344,7 +344,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** @@ -389,7 +389,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### global\_phase - + Return the global phase of the circuit. @@ -469,7 +469,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### node\_counter - + Returns the number of nodes in the dag. @@ -736,7 +736,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### wires - + Return a list of the wires in order. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.mdx index a27257781ea..2223f873a35 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.mdx index 7845dc568a1..e15c1b9546d 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # qiskit.dagcircuit.DAGDepNode - + Object to represent the information at a node in the DAGDependency(). It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -56,19 +56,19 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.mdx index 76f1d8958db..5c13d2d6885 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # qiskit.dagcircuit.DAGDependency - + Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed. @@ -114,7 +114,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -293,7 +293,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### global\_phase - + Return the global phase of the circuit. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.mdx index 37d16e30282..1345c274f80 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # qiskit.dagcircuit.DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -43,25 +43,25 @@ python_api_name: qiskit.dagcircuit.DAGNode ### condition - + Returns the condition of the node.op ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** @@ -82,7 +82,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### wire - + Returns the Bit object, else None. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.mdx index 9f0ca491d33..afc8f1ae8b3 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # qiskit.extensions.HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t @@ -208,19 +208,19 @@ python_api_name: qiskit.extensions.HamiltonianGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### params - + return instruction params. @@ -380,7 +380,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.25/qiskit.extensions.Initialize.mdx index 65cdea9aaf6..f18e987a2ab 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.25/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # qiskit.extensions.Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers. Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. @@ -146,19 +146,19 @@ python_api_name: qiskit.extensions.Initialize ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.extensions.Initialize ### params - + return instruction params. @@ -294,7 +294,7 @@ python_api_name: qiskit.extensions.Initialize ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.mdx index a27821f84ac..9a229bd9a2a 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # qiskit.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -163,7 +163,7 @@ python_api_name: qiskit.extensions.Snapshot ### label - + Return snapshot label @@ -185,7 +185,7 @@ python_api_name: qiskit.extensions.Snapshot ### params - + return instruction params. @@ -239,7 +239,7 @@ python_api_name: qiskit.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.mdx index 9dde9d4a6f5..f618d6b6234 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # qiskit.extensions.UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. @@ -207,19 +207,19 @@ python_api_name: qiskit.extensions.UnitaryGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### params - + return instruction params. @@ -379,7 +379,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.mdx index ec0d88deb2b..1fc4c51b85a 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index d7f67001b29..6eb9cad9b70 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # qiskit.finance.components.uncertainty\_problems.EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -151,7 +151,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 6fb62e94231..29664f6cbe0 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # qiskit.finance.components.uncertainty\_problems.EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -155,7 +155,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 9146304c8eb..743382d8479 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # qiskit.finance.components.uncertainty\_problems.FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. @@ -157,7 +157,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.mdx index b12af8df2e6..f94fc28a515 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # qiskit.finance.data\_providers.BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -17,7 +17,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -136,7 +136,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.mdx index fbf9b10dd1d..1c540f4e596 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # qiskit.finance.data\_providers.DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.mdx index 62a79450642..81ea451df61 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # qiskit.finance.data\_providers.ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.mdx index 4d9c5fbfb65..b204dd97849 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # qiskit.finance.data\_providers.RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type start: `datetime` :param start: first data point :type end: `datetime` :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.mdx index dd8223e6cd4..d15da364bae 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # qiskit.finance.data\_providers.StockMarket - + Stock Market enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 023b8271d31..e835736bd3a 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # qiskit.finance.data\_providers.WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.mdx index 7191e3eb1c2..6127b66fd16 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # qiskit.finance.data\_providers.YahooDataProvider - + Yahoo data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.mdx index f3d425d3b47..0fcf9661fcc 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # qiskit.ignis.characterization.AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.mdx index 81c6416d1a0..3895433f18f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # qiskit.ignis.characterization.AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 5cae1dd86fb..835a2557461 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # qiskit.ignis.characterization.AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.mdx index eff4166e29e..6da3dd6f598 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # qiskit.ignis.characterization.AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 3f7298c8cac..6c1f702e96d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # qiskit.ignis.characterization.BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.mdx index 67337efff90..e3b8343d1fc 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # qiskit.ignis.characterization.BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.mdx index c6d8618859b..96fea6f87d2 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # qiskit.ignis.characterization.DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.mdx index 451250e59f0..130ea82fb23 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # qiskit.ignis.characterization.RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ @@ -63,7 +63,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.mdx index f891073becd..c637555fae3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # qiskit.ignis.characterization.T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. @@ -75,7 +75,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -223,7 +223,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -233,7 +233,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.mdx index 48c153a777b..1b5f329eb5f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # qiskit.ignis.characterization.T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -176,7 +176,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -224,7 +224,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -234,7 +234,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.mdx index c32236e17fd..d3fed73eabd 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # qiskit.ignis.characterization.T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -242,7 +242,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -252,7 +252,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.mdx index 07adf6c7edb..ff69a1f4e7f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # qiskit.ignis.characterization.ZZFitter - + ZZ fitter ### \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.mdx index d9f7edb1ce8..19a3582b148 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # qiskit.ignis.logging.IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.mdx index 59417cb2165..b6e9c3ba0a3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # qiskit.ignis.logging.IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.mdx index 1fc8c56fc0e..1adb06a713e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # qiskit.ignis.logging.IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.mdx index 77dafde2131..5625ef587c9 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # qiskit.ignis.measurement.DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 231150bc93a..c3f15566789 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # qiskit.ignis.measurement.IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -85,19 +85,19 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### expected\_states - + Returns the expected states used to train the discriminator. ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. ### fitted - + True if the discriminator has been fitted to calibration data. @@ -236,7 +236,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 960417a844c..1cc340b8f18 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # qiskit.ignis.measurement.LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index deca26b8d9b..63dcc749e1b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # qiskit.ignis.measurement.QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index 3198ef0729f..bb38c72f3ac 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # qiskit.ignis.measurement.SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -99,7 +99,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index b32b4fedc2b..f3bdad81056 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # qiskit.ignis.mitigation.CTMPExpvalMeasMitigator - + N-qubit CTMP measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 2c346fc747f..41bc15188f2 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # qiskit.ignis.mitigation.CompleteExpvalMeasMitigator - + N-qubit measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index edb0220a002..311cfe9dff7 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # qiskit.ignis.mitigation.CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits @@ -69,13 +69,13 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### cal\_matrix - + Return cal\_matrix. ### filter - + Return a measurement filter using the cal matrix. @@ -92,7 +92,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### qubit\_list - + Return list of qubits. @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### state\_labels - + Return state\_labels. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index bba1c825c89..5d4e0fb721e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter - + Expectation value measurement error mitigator calibration fitter. See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter ### mitigator - + Return the fitted mitigator object diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.mdx index bad192ad4c9..4e49d3d9ca9 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # qiskit.ignis.mitigation.MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. @@ -87,13 +87,13 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter ### cal\_matrix - + Return cal\_matrix. ### state\_labels - + return the state label ordering of the cal matrix diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index 1bf39854ce1..2393eb6c6a4 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # qiskit.ignis.mitigation.TensoredExpvalMeasMitigator - + 1-qubit tensor product measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.mdx index e95839c22a7..4ea9dd389a6 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # qiskit.ignis.mitigation.TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### cal\_matrices - + Return cal\_matrices. @@ -132,19 +132,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### nqubits - + Return the number of qubits. See also MeasurementFilter.apply() ### qubit\_list\_sizes - + Return \_qubit\_list\_sizes. ### substate\_labels\_list - + Return \_substate\_labels\_list diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index d8f51cfe1c5..86f411e4057 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # qiskit.ignis.mitigation.TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. @@ -72,19 +72,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### cal\_matrices - + Return cal\_matrices. ### filter - + Return a measurement filter using the cal matrices. ### nqubits - + Return \_qubit\_list\_sizes. @@ -134,7 +134,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### substate\_labels\_list - + Return \_substate\_labels\_list. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.mdx index 1e10b61f70d..ab2a0651a33 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # qiskit.ignis.verification.AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.mdx index cd548abfdec..ff65a5b3863 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # qiskit.ignis.verification.AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.mdx index 2674216d626..dd4551bc7e5 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # qiskit.ignis.verification.BConfig - + This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.mdx index 84272747b04..942c0a7ad16 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # qiskit.ignis.verification.CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. **References** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -203,13 +203,13 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### key - + Return a string representation of a CNOT-dihedral object. ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -249,7 +249,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 53779d9ea3f..e17ccfa97fb 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # qiskit.ignis.verification.CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. @@ -88,19 +88,19 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### cliff\_lengths - + Return group elements lengths. ### fit - + Return fit as a 2 element list. ### fit\_cnotdihedral - + Return cnotdihedral fit parameters. @@ -158,43 +158,43 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### raw\_data - + Return raw\_data as 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_X - + Return the cnotdihedral X fitter. ### rbfit\_Z - + Return the cnotdihedral Z fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.mdx index bef77c48908..8c6b3996733 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # qiskit.ignis.verification.GatesetTomographyFitter - + Initialize gateset tomography fitter with experimental data. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.mdx index 9034971fc56..5a181f0ceab 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # qiskit.ignis.verification.GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.mdx index 18c3ddd3b1a..d0763c4eb6a 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # qiskit.ignis.verification.InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. @@ -92,13 +92,13 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit as a 2 element list. @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### fit\_int - + Return interleaved fit parameters. @@ -155,43 +155,43 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### raw\_data - + Return raw\_data as a 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_int - + Return the interleaved RB fitter. ### rbfit\_std - + Return the original RB fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.mdx index 5b2620265c2..58a4ad6472e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # qiskit.ignis.verification.Plotter - + Various plots of the ground state in MQC and PO experiments ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 4986354d75e..8efae59b513 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # qiskit.ignis.verification.ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### data - + Return tomography data @@ -146,13 +146,13 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.mdx index e158e83ebb6..034e74b0c4f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # qiskit.ignis.verification.PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -112,13 +112,13 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return the purity fit parameters. @@ -161,37 +161,37 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_pur - + Return the purity RB fitter. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.mdx index 155d27ff3fb..5cfe7c30e9d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # qiskit.ignis.verification.QVFitter - + Class for fitters for quantum volume. **Parameters** @@ -152,25 +152,25 @@ python_api_name: qiskit.ignis.verification.QVFitter ### depths - + Return depth list. ### heavy\_output\_counts - + Return the number of heavy output counts as measured. ### heavy\_output\_prob\_ideal - + Return the heavy output probability ideally. ### heavy\_outputs - + Return the ideal heavy outputs dictionary. @@ -254,7 +254,7 @@ python_api_name: qiskit.ignis.verification.QVFitter ### qubit\_lists - + Return depth list. @@ -274,13 +274,13 @@ python_api_name: qiskit.ignis.verification.QVFitter ### results - + Return all the results. ### ydata - + Return the average and std of the output probability. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.mdx index 685ea07071c..985a5a4a60a 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # qiskit.ignis.verification.RBFitter - + Class for fitters for randomized benchmarking. **Parameters** @@ -91,13 +91,13 @@ python_api_name: qiskit.ignis.verification.RBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit. @@ -151,31 +151,31 @@ python_api_name: qiskit.ignis.verification.RBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.mdx index 8e0aa13fe2f..c6f3feb5f1d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # qiskit.ignis.verification.RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.mdx index 40c093860dc..4b648fd4806 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # qiskit.ignis.verification.StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### data - + Return tomography data @@ -134,13 +134,13 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.mdx index 210024aa6c3..e726f44185c 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # qiskit.ignis.verification.TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### data - + Return tomography data @@ -139,13 +139,13 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.mdx index c298c5b8cf8..05ad20a244b 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # qiskit.ml.circuit.library.RawFeatureVector - + The raw feature vector circuit. This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. @@ -262,7 +262,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -311,7 +311,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -321,7 +321,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -357,19 +357,19 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -587,7 +587,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### data - + Return the circuit data (instructions and context). **Returns** @@ -794,7 +794,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### feature\_dimension - + Return the feature dimension. **Return type** @@ -814,7 +814,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -832,7 +832,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -850,7 +850,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### global\_phase - + Return the global phase of the circuit in radians. @@ -1263,7 +1263,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1277,13 +1277,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1315,7 +1315,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1325,7 +1325,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1355,7 +1355,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ordered\_parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1375,7 +1375,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1462,7 +1462,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qregs - + A list of the quantum registers associated with the circuit. @@ -1536,7 +1536,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.mdx index c4c9377bab4..b77a9f68a00 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # qiskit.opflow\.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms. @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -152,7 +152,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -190,7 +190,7 @@ python_api_name: qiskit.opflow.OperatorBase ### instance\_id - + Return the unique instance id. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -232,7 +232,7 @@ python_api_name: qiskit.opflow.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -246,13 +246,13 @@ python_api_name: qiskit.opflow.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -274,7 +274,7 @@ python_api_name: qiskit.opflow.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -338,7 +338,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.mdx index ba7506b1ae2..6c84da9a7c5 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.mdx index 189f13d6312..30793bcabc2 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # qiskit.opflow\.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.mdx index cac7b4701f0..2cb65167d0d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # qiskit.opflow\.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -91,7 +91,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.mdx index ca78c680dc6..0a8236f3414 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: 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. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.mdx index 68aa401408c..c101a7e72fc 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # qiskit.opflow\.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.mdx index b0a4339ac41..2a88b2e95df 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # qiskit.opflow\.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.mdx index ca5f23f44a6..1149c7de676 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # qiskit.opflow\.converters.TwoQubitReduction - + Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.mdx index fb6942b9eac..319fad60d56 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # qiskit.opflow\.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.mdx index 3015e63ad6d..4307ba9028e 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # qiskit.opflow\.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.mdx index 343c2ba7f2c..f7a8b7072f4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # qiskit.opflow\.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -339,7 +339,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.mdx index 5c1c0bb0633..37584d0b1a9 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: 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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 86fb846cda4..802993f8c7e 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # qiskit.opflow\.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.mdx index 973696c8101..d4e2334de57 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # qiskit.opflow\.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.mdx index c5d621e5685..45182a39450 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # qiskit.opflow\.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.mdx index 5e3589b216d..67b0c31e2c4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # qiskit.opflow\.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.mdx index 8f8d35f2176..8e93902e7f4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # qiskit.opflow\.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 77e79b9b50f..13706eb8d80 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # qiskit.opflow\.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.mdx index 0949a77d78f..ecdca70e797 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # qiskit.opflow\.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.mdx index bddf7d66280..f0c270cb8d2 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # qiskit.opflow\.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.mdx index 87d88b0445c..20138e0222c 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # qiskit.opflow\.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.mdx index 52ab8fcb878..c8a8c0bed3d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # qiskit.opflow\.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.mdx index a348a6f16a6..4db723e487f 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # qiskit.opflow\.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.mdx index fe0b5c9a89a..50f40847244 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # qiskit.opflow\.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.mdx index 17c9d23cd68..afc869f6803 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # qiskit.opflow\.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.mdx index b3eb5b129e4..1755df95faa 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # qiskit.opflow\.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.mdx index a62cbcf624c..6e0d6fa835c 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # qiskit.opflow\.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.mdx index d05da2b585d..b187e1a419f 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # qiskit.opflow\.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.mdx index bbeb6738ac6..e38607f9e2f 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # qiskit.opflow\.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.mdx index 2970f50da08..45700a4921e 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # qiskit.opflow\.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.mdx index 8ceb0bef3f3..26d09c88ce8 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # qiskit.opflow\.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.mdx index c5d80b1cf27..180e522737c 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # qiskit.opflow\.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -147,7 +147,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.mdx index 891b8ba0d34..5cdd4ea3e1c 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # qiskit.opflow\.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parameterized quantum state, where QFI is: @@ -97,7 +97,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -116,7 +116,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.mdx index 1671ffe435a..4835ceb5234 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # qiskit.opflow\.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.mdx index d974f06623f..1321ff3a1e0 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # qiskit.opflow\.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -358,7 +358,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.mdx index f721205a1dd..c8a771aaffa 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # qiskit.opflow\.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### instance\_id - + Return the unique instance id. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -384,7 +384,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.mdx index 918ec65c28a..b5691decef7 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # qiskit.opflow\.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -392,7 +392,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.mdx index ca947fa5de4..e4935df5787 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # qiskit.opflow\.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### instance\_id - + Return the unique instance id. **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -357,7 +357,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.mdx index 988ed0b4d73..f8475d2ed87 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # qiskit.opflow\.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -345,7 +345,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.mdx index 1b0a78fbd83..36bb26febc4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # qiskit.opflow\.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -349,7 +349,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.mdx index efc160b9f97..fa9f4240cb7 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # qiskit.opflow\.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### instance\_id - + Return the unique instance id. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -301,7 +301,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 3db92a8dca2..d46c8e87812 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # qiskit.opflow\.primitive\_ops.PauliSumOp - + Class for Operators backend by Terra’s `SparsePauliOp` class. **Parameters** @@ -144,7 +144,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -248,7 +248,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -423,7 +423,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 1a9e11ea32b..a8370c8dbbd 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # qiskit.opflow\.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### instance\_id - + Return the unique instance id. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -341,7 +341,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 331c1a2773d..ccc36bd63f4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # qiskit.opflow\.primitive\_ops.TaperedPauliSumOp - + Class for PauliSumOp after tapering **Parameters** @@ -145,7 +145,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -249,7 +249,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -268,7 +268,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -424,7 +424,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -593,7 +593,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### z2\_symmetries - + Z2 symmetries which the Operator has. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 9a03fe2796a..59e45423a36 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # qiskit.opflow\.primitive\_ops.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian. @@ -94,7 +94,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -114,19 +114,19 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### tapering\_values - + returns tapering values diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.mdx index a777edec949..f29696eb867 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # qiskit.opflow\.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -166,7 +166,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### instance\_id - + Return the unique instance id. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -429,7 +429,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.mdx index 59b7bac50bc..a67e73011a8 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # qiskit.opflow\.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -260,7 +260,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -368,7 +368,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.mdx index 495815205a6..e8c4153425d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # qiskit.opflow\.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -329,7 +329,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.mdx index 7a59f2bec8c..70c79967b23 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # qiskit.opflow\.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index a87bee5dd45..f4b12c18f38 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # qiskit.opflow\.state\_fns.SparseVectorStateFn - + A class for sparse state functions and measurements in vector representation. This class uses `scipy.sparse.spmatrix` for the internal representation. @@ -143,7 +143,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -333,7 +333,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.mdx index e59a578cbd1..8dfd3d675cd 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # qiskit.opflow\.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.mdx index 39840549f68..5d7b4797e1b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # qiskit.opflow\.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.mdx index 57f4848eb03..cf80f51af66 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.mdx index c6a662e3b43..a7214bb57c2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # qiskit.optimization.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 2a05542589f..fac5d6db3ec 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # qiskit.optimization.algorithms.ADMMOptimizationResult - + ADMMOptimization Result. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### state - + returns state **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.mdx index ce8fa022986..aab119a9138 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # qiskit.optimization.algorithms.ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer ### parameters - + Returns current parameters of the optimizer. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.mdx index f0389705c6e..90db1cd91a2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # qiskit.optimization.algorithms.ADMMParameters - + Defines a set of parameters for ADMM optimizer. Defines parameters for ADMM optimizer and their default values. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.mdx index 4595f865b33..6614f4c70e0 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # qiskit.optimization.algorithms.ADMMState - + Internal computation state of the ADMM implementation. The state keeps track of various variables are stored that are being updated during problem solving. The values are relevant to the problem being solved. The state is recreated for each optimization problem. State is returned as the third value. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 6e923b0ccd7..c004ba4e818 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # qiskit.optimization.algorithms.CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.mdx index 706d15875e5..69931748b27 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # qiskit.optimization.algorithms.CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index e9ec74f18af..034e93e4f26 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # qiskit.optimization.algorithms.GroverOptimizationResult - + A result object for Grover Optimization methods. Constructs a result object with the specific Grover properties. @@ -69,7 +69,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### intermediate\_fval - + Getter of the intermediate fval **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_input\_qubits - + Getter of n\_input\_qubits **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_output\_qubits - + Getter of n\_output\_qubits **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### operation\_counts - + Get the operation counts. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### threshold - + Getter of the threshold of Grover algorithm. **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.mdx index 7805c09a8d5..c017b2493a5 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # qiskit.optimization.algorithms.GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer ### quantum\_instance - + The quantum instance to run the circuits. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.mdx index 6b7fed092a7..707027da784 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # qiskit.optimization.algorithms.IntermediateResult - + Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 5f41710e8c8..94a19c249b8 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # qiskit.optimization.algorithms.MinimumEigenOptimizationResult - + Minimum Eigen Optimizer Result. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### min\_eigen\_solver\_result - + Returns a result object obtained from the instance of `MinimumEigensolver`. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_samples - + Returns the list of raw solution samples of `MinimumEigensolver`. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index ad5c27f7431..c85991d6206 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # qiskit.optimization.algorithms.MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer ### min\_eigen\_solver - + Returns the minimum eigensolver. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 990cb906264..46f8728fbc6 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # qiskit.optimization.algorithms.MultiStartOptimizer - + An abstract class that implements multi start optimization and should be sub-classed by other optimizers. Constructs an instance of this optimizer. @@ -48,7 +48,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index be4e56a9955..7c401461d24 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # qiskit.optimization.algorithms.OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.mdx index ae2b033deed..8094132f7ed 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # qiskit.optimization.algorithms.OptimizationResult - + A base class for optimization results. The optimization algorithms return an object of the type `OptimizationResult` with the information about the solution obtained. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index a0eff974aad..3c3dc40eb73 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # qiskit.optimization.algorithms.OptimizationResultStatus - + Termination status of an optimization algorithm. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 759447cef02..674ed729cf0 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult - + Recursive Eigen Optimizer Result. Constructs an instance of the result class. @@ -60,7 +60,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### fval - + Returns the optimal function value. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### history - + Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### replacements - + Returns a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### samples - + Returns the list of solution samples **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index af82acf3b40..3e8a9033c99 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index bbede36b2c3..eac72c40a44 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # qiskit.optimization.algorithms.SlsqpOptimizationResult - + SLSQP optimization result, defines additional properties that may be returned by the optimizer. Constructs a result object with properties specific to SLSQP. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fx - + Returns the final value of the objective function being actually optimized. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### imode - + Returns the exit mode from the optimizer. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### its - + Returns the number of iterations **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -126,7 +126,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### smode - + Returns message describing the exit mode from the optimizer. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index e164c53a9ed..f7bc6a8894e 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # qiskit.optimization.algorithms.SlsqpOptimizer - + The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.mdx index 4396d597a6f..1c4fdf310cb 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # qiskit.optimization.algorithms.SolutionSample - + A sample of an optimization solution ### x diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx index 92d3d3d31f2..7eb8cf5d8d2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx @@ -32,12 +32,12 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord - + Alias for field number 2 @@ -49,7 +49,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### dim - + Alias for field number 1 @@ -63,13 +63,13 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### name - + Alias for field number 0 #### w - + Alias for field number 3 diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.mdx index 773b2b14e50..aa541790e65 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # qiskit.optimization.converters.InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality ### mode - + Returns the mode of the converter **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.mdx index 781285ebc33..a784e593b16 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # qiskit.optimization.converters.IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index 613aef79e7f..6b00cbc52a9 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # qiskit.optimization.converters.LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. **Parameters** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 8e9d417f504..f9144290aa3 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # qiskit.optimization.converters.QuadraticProgramConverter - + An abstract class for converters of quadratic programs in Qiskit’s optimization module. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index afbfbf0c222..654306d442b 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # qiskit.optimization.converters.QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.mdx index cacfebafefa..198e25adc32 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # qiskit.optimization.problems.Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -57,7 +57,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.mdx index c6cade6be8f..8012335c854 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # qiskit.optimization.problems.LinearConstraint - + Representation of a linear constraint. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.mdx index 17f8b1b328d..b94cbc7d5eb 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # qiskit.optimization.problems.LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.mdx index 51854c923bc..ff30982abce 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # qiskit.optimization.problems.QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. @@ -81,7 +81,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.mdx index 6bf0a82b458..fb9d9b18740 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # qiskit.optimization.problems.QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.mdx index ccd36875b0e..065d86bfc4d 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # qiskit.optimization.problems.QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### sense - + Returns the sense of the objective function. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.mdx index 2b72e18387b..a0c1ca22a8e 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # qiskit.optimization.problems.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.mdx index fce41233579..2ed7c5c3895 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # qiskit.optimization.problems.QuadraticProgramElement - + Interface class for all objects that have a parent QuadraticProgram. Initialize object with parent QuadraticProgram. @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.mdx index 9b632a061b3..714b11e33fb 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # qiskit.optimization.problems.Variable - + Representation of a variable. Creates a new Variable. @@ -86,7 +86,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.25/qiskit.providers.Backend.mdx index 4c622d7d5d0..275990c1ea9 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # qiskit.providers.Backend - + Base common type for all versioned Backend abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.mdx index 0f3f01bf612..a7b87eb321a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.25/qiskit.providers.BackendV1.mdx index e29d93917b7..424be0b0406 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # qiskit.providers.BackendV1 - + Abstract class for Backends This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.BackendV1 ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. @@ -129,7 +129,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.mdx index 69b37a70800..16e3917607f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # qiskit.providers.BaseBackend - + Legacy Base class for backends. Base class for backends. @@ -26,7 +26,7 @@ python_api_name: qiskit.providers.BaseBackend ### \_\_init\_\_ - + Base class for backends. This method should initialize the module and its configuration, and raise an exception if a component of the module is not available. @@ -112,7 +112,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.BaseJob.mdx index 9a1e3bf93e2..b541b35b6da 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # qiskit.providers.BaseJob - + Legacy Class to handle asynchronous jobs Initializes the asynchronous job. @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -104,7 +104,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -120,13 +120,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.mdx index f98913d12c2..6375f151453 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # qiskit.providers.BaseProvider - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.Job.mdx b/docs/api/qiskit/0.25/qiskit.providers.Job.mdx index 1d10a1b77b7..cda7319d030 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # qiskit.providers.Job - + Base common type for all versioned Job abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.25/qiskit.providers.JobError.mdx index 3eb1b427e63..d3a30520088 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.25/qiskit.providers.JobStatus.mdx index e67e057e5fb..4fb1308aaae 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # qiskit.providers.JobStatus - + Class for job status enumerated type. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.mdx index 3b92d060cc1..a1d801b683e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.25/qiskit.providers.JobV1.mdx index d749faf9bc1..1231d7a0949 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # qiskit.providers.JobV1 - + Class to handle jobs This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -130,13 +130,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.25/qiskit.providers.Options.mdx b/docs/api/qiskit/0.25/qiskit.providers.Options.mdx index 1572b839c81..46b37d5e605 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # qiskit.providers.Options - + Base options object This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. diff --git a/docs/api/qiskit/0.25/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.25/qiskit.providers.Provider.mdx index 77cb7c78f67..70ba4705dc6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # qiskit.providers.Provider - + Base common type for all versioned Provider abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.mdx index 87199668b9c..399803c6bc9 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # qiskit.providers.ProviderV1 - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.mdx index 8b4c8b210ef..131f42829eb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.mdx index 5f19e6662bc..db6c76b8924 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.mdx index 7d436aa2dcd..276c34ed48b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # qiskit.providers.aer.AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.mdx index 4cc9bbc4687..c52b9c43fea 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # qiskit.providers.aer.AerProvider - + Provider for Qiskit Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.mdx index 894385f2b2c..5166e47fa6b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # qiskit.providers.aer.AerSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.mdx index df0ca228569..70031ecd02c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # qiskit.providers.aer.PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.mdx index 43e90230390..5eae2e7dda2 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # qiskit.providers.aer.QasmSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.mdx index 9eb2cb364c1..6baabe9c159 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # qiskit.providers.aer.StatevectorSimulator - + Ideal quantum circuit statevector simulator **Configurable Options** @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.mdx index a6675a75b9b..0868ccf5ad1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # qiskit.providers.aer.UnitarySimulator - + Ideal quantum circuit unitary simulator. **Configurable Options** @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.mdx index 124d02898e9..420ac5f091c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # qiskit.providers.aer.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -134,25 +134,25 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### label - + Return snapshot label @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### params - + return instruction params. @@ -246,7 +246,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 306c587679e..c0b66fdaddb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # qiskit.providers.aer.extensions.SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -136,25 +136,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### label - + Return snapshot label @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### params - + return instruction params. @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### snapshot\_type - + Return snapshot type @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index efd3dc2dfd0..beef7a5cb88 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # qiskit.providers.aer.extensions.SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create an expectation value snapshot instruction. @@ -140,25 +140,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### label - + Return snapshot label @@ -198,7 +198,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### snapshot\_type - + Return snapshot type @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index d95040a3569..42a19cf77cf 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # qiskit.providers.aer.extensions.SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -138,25 +138,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### label - + Return snapshot label @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### params - + return instruction params. @@ -250,7 +250,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### snapshot\_type - + Return snapshot type @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index cce75df839f..5513c400507 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # qiskit.providers.aer.extensions.SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index aaf94825caa..da85a096971 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # qiskit.providers.aer.extensions.SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.mdx index be073927071..b7328f95935 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # qiskit.providers.aer.library.SaveAmplitudes - + Save complex statevector amplitudes. Instruction to save complex statevector amplitudes. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### params - + return instruction params. @@ -249,7 +249,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 44d7c004322..f89b8934cc0 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # qiskit.providers.aer.library.SaveAmplitudesSquared - + Save squared statevector amplitudes (probabilities). Instruction to save squared statevector amplitudes (probabilities). @@ -133,19 +133,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -179,7 +179,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### params - + return instruction params. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.mdx index a24504ca663..6e7ba54dc69 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # qiskit.providers.aer.library.SaveDensityMatrix - + Save a reduced density matrix. Create new instruction to save the simulator reduced density matrix. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.mdx index 7926573f78c..771933d3012 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # qiskit.providers.aer.library.SaveExpectationValue - + Save expectation value of an operator. Instruction to save the expectation value of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 5efb040e989..09aa0bbf8c8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # qiskit.providers.aer.library.SaveExpectationValueVariance - + Save expectation value and variance of an operator. Instruction to save the expectation value and variance of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.mdx index cb0c6d71c32..935ff83b4e6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # qiskit.providers.aer.library.SaveMatrixProductState - + Save matrix product state instruction Create new instruction to save the matrix product state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.mdx index f249fef282a..c3ea4d78da5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # qiskit.providers.aer.library.SaveProbabilities - + Save measurement outcome probabilities vector. Instruction to save measurement probabilities vector. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index a2b8dd8d06a..efee5fd5d58 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # qiskit.providers.aer.library.SaveProbabilitiesDict - + Save measurement outcome probabilities dict. Instruction to save measurement probabilities dict. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.mdx index 2ddab3d3703..532448045c1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # qiskit.providers.aer.library.SaveStabilizer - + Save Stabilizer instruction Create new instruction to save the stabilizer simulator state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.mdx index 1f88f4e933e..55ce2af7211 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # qiskit.providers.aer.library.SaveState - + Save simulator state The format of the saved state depends on the simulation method used. @@ -135,19 +135,19 @@ python_api_name: qiskit.providers.aer.library.SaveState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -181,7 +181,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### params - + return instruction params. @@ -253,7 +253,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.mdx index 5bf9d2df3e9..89e96cdc9bb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # qiskit.providers.aer.library.SaveStatevector - + Save statevector Create new instruction to save the simulator statevector. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 6e3c47d75e9..9030afc159d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # qiskit.providers.aer.library.SaveStatevectorDict - + Save statevector as ket-form dictionary. Create new instruction to save the simulator statevector as a dict. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.mdx index b4c232ab8ba..d1327e1b14c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # qiskit.providers.aer.library.SaveSuperOp - + Save a SuperOp matrix. Create new instruction to save the superop simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.mdx index 3c482c9b6df..5017a57359c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # qiskit.providers.aer.library.SaveUnitary - + Save Unitary Create new instruction to save the unitary simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.mdx index 46e70a5b43a..c3c2c6bb8c7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # qiskit.providers.aer.library.SetDensityMatrix - + Set density matrix state of the simulator Create new instruction to set the density matrix state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.mdx index ccbc1addb72..ec56b616cd3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # qiskit.providers.aer.library.SetMatrixProductState - + Set the matrix product state of the simulator Create new instruction to set the matrix product state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.mdx index ba27f19829a..ffc5da2cab4 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # qiskit.providers.aer.library.SetStabilizer - + Set the Clifford stabilizer state of the simulator Create new instruction to set the Clifford stabilizer state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.mdx index 2ac69a2626d..491db2db87c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # qiskit.providers.aer.library.SetStatevector - + Set the statevector state of the simulator Create new instruction to set the statevector state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.mdx index fef264d4699..28f49f0dbe7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # qiskit.providers.aer.library.SetSuperOp - + Set superop state of the simulator Create new instruction to set the superop simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.mdx index 13bf5ced8e3..5c2c3d28e7a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # qiskit.providers.aer.library.SetUnitary - + Set unitary state of the simulator Create new instruction to set the unitary simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.mdx index 0dc4d932729..34f9b3eb09b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # qiskit.providers.aer.noise.NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -211,13 +211,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### basis\_gates - + Return basis\_gates for compiling to the noise model. ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -279,7 +279,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** @@ -307,13 +307,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### noise\_instructions - + Return the set of noisy instructions for this noise model. ### noise\_qubits - + Return the set of noisy qubits for this noise model. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.mdx index 74b55875e7f..baf24e9adea 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # qiskit.providers.aer.noise.QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -113,13 +113,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### atol - + The default absolute tolerance parameter for float comparisons. ### circuits - + Return the list of error circuits. @@ -231,7 +231,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -259,31 +259,31 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### probabilities - + Return the list of error probabilities. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. ### size - + Return the number of error circuit. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.mdx index 5ade73205a5..c80abb84bb6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # qiskit.providers.aer.noise.ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -105,7 +105,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### atol - + The default absolute tolerance parameter for float comparisons. @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -222,25 +222,25 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### probabilities - + Return the readout error probabilities matrix. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 36fd9160769..2bbe1550693 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # qiskit.providers.aer.pulse.PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.mdx index 614c2a792a2..0fa61f4fa8b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # qiskit.providers.aer.utils.NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ### \_\_init\_\_ @@ -74,7 +74,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -107,13 +107,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -188,7 +188,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.mdx index b2484d426e2..12be712f6d5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.mdx index b63b6e3b53e..0b5583d413b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # qiskit.providers.basicaer.BasicAerJob - + BasicAerJob class. Initializes the asynchronous job. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.mdx index c1939d01626..7d4a7713428 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # qiskit.providers.basicaer.BasicAerProvider - + Provider for Basic Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 812266ea5a5..3223ff61ecb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # qiskit.providers.basicaer.QasmSimulatorPy - + Python implementation of a qasm simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index e7b59279ebc..e830fe662f3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # qiskit.providers.basicaer.StatevectorSimulatorPy - + Python statevector simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 9ca017e38d9..d995e3d1ea7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # qiskit.providers.basicaer.UnitarySimulatorPy - + Python implementation of a unitary simulator. Initialize a backend class @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.mdx index 37b65df94ff..a2bc6de1432 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # qiskit.providers.ibmq.AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### backend - + Return the backend service. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### experiment - + Return the experiment service. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### random - + Return the random number service. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.mdx index 697633fe377..d251afdb7d3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # qiskit.providers.ibmq.BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index eb7feff2bac..d57dcbd7817 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index ba99d44fd50..2d7408fb3e8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 58d46b77348..c29b30f931f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index b25ec8261e2..1c1aa59bcfb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.mdx index 1ccca633423..e9481c13b84 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index a62526ee6a0..777a913cc25 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.mdx index 95fe2a2fa5f..02881f69ece 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # qiskit.providers.ibmq.IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -266,7 +266,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 5f737f25ece..b5de7bbbd45 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 024d6b1cb27..11756cd7894 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.mdx index be925b80a3f..ea27bd28485 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.mdx index 603623bb3e7..83e9fbe7463 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # qiskit.providers.ibmq.IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.mdx index d3dc25b51af..141f3c83b37 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.mdx index c0a9e10ff6c..930118da3fb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.mdx index af375ce0be3..65c6e71c14b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # qiskit.providers.ibmq.IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.mdx index 882e96e106c..164e6525486 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.mdx index 34288d623b2..294dc21adaf 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # qiskit.providers.ibmq.credentials.Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.mdx index df431abf059..88b7cde8cd5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 73dd8297d73..3bc4fbf7ed8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 12f5b742064..63f1ada6a09 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.mdx index 483cd9ccbe9..c3261708927 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult # qiskit.providers.ibmq.experiment.AnalysisResult - + Class representing an analysis result for an experiment. AnalysisResult constructor. @@ -70,7 +70,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### quality - + Return the analysis result quality. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### uuid - + Return UUID of this analysis result. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.mdx index a81065a90eb..eb910d121d1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment # qiskit.providers.ibmq.experiment.Experiment - + Class representing an experiment. Experiment constructor. @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### analysis\_results - + Return analysis results associated with this experiment. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### backend\_name - + Return the experiment’s backend name. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### end\_datetime - + Return the timestamp when the experiment ended. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### group - + Return the experiment’s group. **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### hub - + Return the experiment’s hub. **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### owner - + Return the experiment’s owner. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### plot\_names - + Return names of plots associated with this experiment. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### project - + Return the experiment’s project. **Return type** @@ -255,7 +255,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### share\_level - + Return the experiment share\_level. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### start\_datetime - + Return the timestamp when the experiment started. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -299,7 +299,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### uuid - + Return the experiment’s uuid. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.mdx index 4fd74e95b05..fada86a7327 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService # qiskit.providers.ibmq.experiment.ExperimentService - + Provides experiment related services. This class is the main interface to invoke IBM Quantum Experience experiment services, which allow you to create, delete, update, query, and retrieve experiments, experiment plots, and analysis results. The `experiment` attribute of `AccountProvider` is an instance of this class, and the main syntax for using the services is `provider.experiment.`. For example: diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.mdx index 506006fc068..1a5a46dca51 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # qiskit.providers.ibmq.job.IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### experiment\_id - + Return the experiment ID. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 58645694585..b2fa76f33da 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.mdx index 5f4b8ad784e..a1695794727 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index e433b87aba1..8dd87a47f84 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 6f4dd9fc1f0..140f0994483 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 176aab0be54..e56bb2ecc22 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.mdx index 8c85178c58e..2300d7da148 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # qiskit.providers.ibmq.job.QueueInfo - + Queue information for a job. QueueInfo constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index efe0ce864b4..4fe9a386d3b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # qiskit.providers.ibmq.managed.IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 9e7da8c126d..8e5c9a01ddc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index ff0c9b4a40e..250b906c5b8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 6144db72e6a..b36ae617ee6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 5c89e92de50..db120a6d8cc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 6ec29f858a4..e7c650e284c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 7fc6213aed0..b07656fa7d6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.mdx index 5a53f6b388c..a810056c151 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # qiskit.providers.ibmq.managed.ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index db4551e8d8d..7b2dbed4426 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # qiskit.providers.ibmq.managed.ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.mdx index dc23f6c8a48..82b9cb6afbb 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # qiskit.providers.ibmq.managed.ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.mdx index ad4f7a858ad..cbbf21f7982 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # qiskit.providers.ibmq.random.CQCExtractor - + Class for interfacing with a CQC remote extractor. There are two extractor methods - Dodis (extractor 1) and Hayashi (extractor 2). These methods can be invoked synchronously or asynchronously. To invoke them synchronously: diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index 3bbc646aa69..926ec3228e1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # qiskit.providers.ibmq.random.CQCExtractorJob - + Representation of an asynchronous call to the CQC extractor. An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### extractor\_method - + Return the extractor method used. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### parameters - + Return the parameters passed to the extractor. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 699b663e26e..eae1908ba4f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # qiskit.providers.ibmq.random.IBMQRandomService - + Random number services for an IBM Quantum Experience account provider. Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.mdx index 835c69bffe8..3966f38ccc8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # qiskit.providers.models.BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -171,7 +171,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.mdx index 19831bd1248..4ac5e58fa39 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # qiskit.providers.models.BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.mdx index 7ee84f27f2e..cfa0d4bcb58 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # qiskit.providers.models.BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.Command.mdx index f271532881b..09339522c2e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # qiskit.providers.models.Command - + Class representing a Command. ### name @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.mdx index 6328f6e2f8a..9cadfb03502 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # qiskit.providers.models.GateConfig - + Class representing a Gate Configuration ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.mdx index ff641da23ac..4eef33439cc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # qiskit.providers.models.JobStatus - + Model for JobStatus. ### job\_id @@ -57,7 +57,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.mdx index 464ead889fa..201d8389a00 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # qiskit.providers.models.PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -222,7 +222,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. @@ -302,7 +302,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### sample\_rate - + Sample rate of the signal channels in Hz (1/dt). **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.mdx index 3f73d57c7ff..1ce944c27fd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # qiskit.providers.models.PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_est: `List`\[`float`] :param qubit\_freq\_est: Estimated qubit frequencies in GHz. :type meas\_freq\_est: `List`\[`float`] :param meas\_freq\_est: Estimated measurement cavity frequencies in GHz. :type buffer: `int` :param buffer: Default buffer time (in units of dt) between pulses. :type pulse\_library: `List`\[`PulseLibraryItem`] :param pulse\_library: Pulse name and sample definitions. :type cmd\_def: `List`\[`Command`] :param cmd\_def: Operation name and definition in terms of Commands. :type meas\_kernel: `Optional`\[`MeasurementKernel`] :param meas\_kernel: The measurement kernels :type discriminator: `Optional`\[`Discriminator`] :param discriminator: The discriminators :param \*\*kwargs: Other attributes for the super class. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.mdx index 5eb5950711a..df737732e9e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # qiskit.providers.models.QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -237,7 +237,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.mdx index bd425b6f965..be49880ae93 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # qiskit.providers.models.UchannelLO - + Class representing a U Channel LO ### q @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.mdx index 04c467487a0..de9e397a36c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # qiskit.pulse.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.mdx index e8849c39357..c1ba243408b 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # qiskit.pulse.AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Call.mdx index c301aa87d8a..a21446bd64c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # qiskit.pulse.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Constant.mdx index 98d9088c783..99040f927d4 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # qiskit.pulse.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.mdx index be438ad48cc..eb35cf8a9bd 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # qiskit.pulse.ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.ControlChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.ControlChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.ControlChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Delay.mdx index 4ba9ee473c3..aa4746f0f2f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # qiskit.pulse.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Drag.mdx index 174790576a5..a7c91e4f7c9 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # qiskit.pulse.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.mdx index c8966755f80..51d1d84cd36 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # qiskit.pulse.DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.DriveChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.DriveChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.DriveChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.mdx index 4961ba06abb..eff0e640dcd 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # qiskit.pulse.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.mdx index 6842ecdee91..bc3d3c43b1e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # qiskit.pulse.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.mdx index dbb0c789ab0..2b54880946e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # qiskit.pulse.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.mdx index d58be50ce63..9b96447fb6f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: 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: ```python @@ -155,7 +155,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap ### instructions - + Return all instructions which have definitions. By default, these are typically the basis gates along with other instructions such as measure and reset. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.mdx index d0845b04c06..697c9f789f3 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # qiskit.pulse.MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.mdx index 0d50a138f42..e113a86c2ad 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # qiskit.pulse.MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MemorySlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MemorySlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MemorySlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Play.mdx index 70aac063699..765ff73c74e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # qiskit.pulse.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.25/qiskit.pulse.PulseError.mdx index fb3138e4440..66e757720f6 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.mdx index f1f6b07fd9b..00735c5b621 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # qiskit.pulse.RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.mdx index 81b5b6f5204..2e66e3220b4 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # qiskit.pulse.Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Pulse program representation for the original Qiskit Pulse model \[1]. Instructions are not allowed to overlap in time on the same channel. This overlap constraint is immediately evaluated when a new instruction is added to the `Schedule` object. @@ -198,7 +198,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -280,7 +280,7 @@ $$ ### duration - + Duration of this schedule. **Return type** @@ -381,7 +381,7 @@ $$ ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -401,7 +401,7 @@ $$ ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -413,7 +413,7 @@ $$ ### name - + Name of this Schedule **Return type** @@ -423,7 +423,7 @@ $$ ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -508,7 +508,7 @@ $$ ### start\_time - + Starting time of this schedule. **Return type** @@ -518,7 +518,7 @@ $$ ### stop\_time - + Stopping time of this schedule. **Return type** @@ -528,7 +528,7 @@ $$ ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.mdx index 7f7e8d818fd..27de9bbd485 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # qiskit.pulse.ScheduleBlock - + A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. `ScheduleBlock` s should be initialized with one of the following alignment contexts: @@ -121,7 +121,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### alignment\_context - + Return alignment instance that allocates block component to generate schedule. @@ -212,7 +212,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### channels - + Returns channels that this schedule clock uses. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### duration - + Duration of this schedule block. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -435,7 +435,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -447,7 +447,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### name - + Name of this Schedule **Return type** @@ -457,7 +457,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -507,7 +507,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### start\_time - + Starting time of this schedule block. **Return type** @@ -517,7 +517,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### stop\_time - + Stopping time of this schedule block. **Return type** @@ -527,7 +527,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.mdx index 5eb564a59c4..500244af041 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # qiskit.pulse.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.mdx index c6f37e0bb03..0486fd77125 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # qiskit.pulse.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.mdx index bc377ab9bd0..6ff1db22a6e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # qiskit.pulse.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.mdx index ddae5dbc5de..9c40b64e207 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # qiskit.pulse.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.mdx index bd6ca6ac928..6a91d1d2082 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # qiskit.pulse.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.25/qiskit.pulse.Waveform.mdx index 770451a88cc..d6c14cb7d96 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # qiskit.pulse.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.25/qiskit.pulse.channels.mdx index e0b5f43be86..a87854aa1a6 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.channels.mdx @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -68,7 +68,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -88,7 +88,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -98,7 +98,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -109,7 +109,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -147,7 +147,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -167,7 +167,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -177,7 +177,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -194,7 +194,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -228,7 +228,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -248,7 +248,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -258,7 +258,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -269,7 +269,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -303,7 +303,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -323,7 +323,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -333,7 +333,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -344,7 +344,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -378,7 +378,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -398,7 +398,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -408,7 +408,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -419,7 +419,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -453,7 +453,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -473,7 +473,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -483,7 +483,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -494,7 +494,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -528,7 +528,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -548,7 +548,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -558,7 +558,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -569,7 +569,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -603,7 +603,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -623,7 +623,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -633,7 +633,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -644,7 +644,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify instructions for simulators. Create new snapshot channel. @@ -674,7 +674,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -694,7 +694,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -704,7 +704,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.mdx index af9f8dbb6a9..660d4e1ef23 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # qiskit.pulse.instructions.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.mdx index 6a3c37b217d..608894d76fe 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # qiskit.pulse.instructions.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.instructions.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.instructions.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.instructions.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.instructions.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.instructions.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.instructions.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.instructions.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.instructions.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.mdx index 8369b86de1d..56efceb15af 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # qiskit.pulse.instructions.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.mdx index 3f66630c539..89245bafc8e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # qiskit.pulse.instructions.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.mdx index 68536f999f7..c2dacd0a149 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # qiskit.pulse.instructions.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.mdx index 302bc37ba37..b084a04889d 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # qiskit.pulse.instructions.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.mdx index 93cf1ad2699..5cf2ae154e0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # qiskit.pulse.instructions.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.mdx index 5a8930f2920..1dabcd5fed6 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # qiskit.pulse.instructions.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.mdx index f0221bed8b8..1fa264f637f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # qiskit.pulse.instructions.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.mdx index dc7b7ff5b4e..352a9384892 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # qiskit.pulse.instructions.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.mdx index 7eb62e78e52..6233339c1e7 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # qiskit.pulse.library.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.mdx index a51fe226b4f..46679e23f40 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # qiskit.pulse.library.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.mdx index dda44ccfc77..3101aaa187a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # qiskit.pulse.library.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.mdx index d18de5bda5e..b4c75c6bfaf 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # qiskit.pulse.library.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.mdx index 2d79eee73c6..539f80531ef 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # qiskit.pulse.library.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.library.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.library.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.library.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.mdx index 608593533b7..ca41aa3b3a8 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # qiskit.qasm.OpenQASMLexer - + A pygments lexer for OpenQasm. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.25/qiskit.qasm.Qasm.mdx index 70d410e9d98..63643e69578 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.25/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # qiskit.qasm.Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.25/qiskit.qasm.QasmError.mdx index 14cd87fd355..6f66c674dd7 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.mdx index d237f6cc831..3bfc1bb74cd 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # qiskit.qasm.QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.mdx index 1a4ba1855b3..c934e1e9a97 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # qiskit.qasm.QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.mdx index 92e3b6ecd21..2080aa686db 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # qiskit.qobj.GateCalibration - + Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. Initialize a single gate calibration. Instructions may reference waveforms which should be made available in the pulse\_library. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.mdx index a16243a4252..00271820301 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # qiskit.qobj.PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.mdx index 64ff513dfab..7db8fd837ed 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # qiskit.qobj.PulseQobj - + A Pulse Qobj. Instantiate a new Pulse Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.mdx index e89d9636d04..046832aa29f 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # qiskit.qobj.PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.mdx index 74b0437befc..397d7c6b08f 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # qiskit.qobj.PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.mdx index f9f59971220..a322a985846 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # qiskit.qobj.PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.mdx index 033ce00ecff..e2a4d3161a6 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # qiskit.qobj.PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -69,7 +69,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.mdx index 9c1676d51e0..950978a2122 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # qiskit.qobj.QasmExperimentCalibrations - + A container for any calibrations data. The gates attribute contains a list of GateCalibrations. Initialize a container for calibrations. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.mdx index 7eda1eb6859..c9a1b870632 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # qiskit.qobj.QasmQobj - + A QASM Qobj. Instantiate a new QASM Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.mdx index 591875f1890..34ee1f024be 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # qiskit.qobj.QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.mdx index a5471ffae90..8fd80a224c6 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # qiskit.qobj.QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.mdx index f0fdc45a153..81c2439bc39 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # qiskit.qobj.QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.mdx index 1c7452d3042..c7263876019 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # qiskit.qobj.QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instantiate a new QasmQobjInstruction object. @@ -59,7 +59,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.25/qiskit.qobj.Qobj.mdx index 2168992b323..45efedcd247 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # qiskit.qobj.Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.mdx index a2f87d48f39..53b1a30cd5d 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # qiskit.qobj.QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.mdx index 1ca7a1fdafb..be9f79fb536 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # qiskit.qobj.QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.mdx index 1e53087d0c8..ed169601163 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # qiskit.qobj.QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.mdx index 32369bab1cc..964f8c55e08 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # qiskit.quantum\_info.CNOTDihedral - + An N-qubit operator from the CNOT-Dihedral group. > The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -216,7 +216,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.mdx index e5b0d1fe285..9199d2d2966 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # qiskit.quantum\_info.Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.mdx index 922747afa95..ac260b1ee2d 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # qiskit.quantum\_info.Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.mdx index a1b491e0259..a29ae1c1cff 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # qiskit.quantum\_info.Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -158,13 +158,13 @@ python_api_name: qiskit.quantum_info.Clifford ### destabilizer - + Return the destabilizer block of the StabilizerTable. ### dim - + Return tuple (input\_shape, output\_shape). @@ -209,7 +209,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -231,13 +231,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -297,7 +297,7 @@ python_api_name: qiskit.quantum_info.Clifford ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -331,7 +331,7 @@ python_api_name: qiskit.quantum_info.Clifford ### qargs - + Return the qargs for the operator. @@ -361,13 +361,13 @@ python_api_name: qiskit.quantum_info.Clifford ### stabilizer - + Return the stabilizer block of the StabilizerTable. ### table - + Return StabilizerTable diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.mdx index 6e5dd41cf01..e4ee2bb649a 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # qiskit.quantum\_info.DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### data - + Return data. ### dim - + Return total state dimension. @@ -227,7 +227,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -277,7 +277,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -336,7 +336,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -480,7 +480,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.mdx index 782285ef5f9..1b347a34c1d 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # qiskit.quantum\_info.Kraus - + Kraus representation of a quantum channel. For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -112,7 +112,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -164,13 +164,13 @@ $$ ### data - + Return list of Kraus matrices for channel. ### dim - + Return tuple (input\_shape, output\_shape). @@ -245,7 +245,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -283,7 +283,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -313,7 +313,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 67fe93c0e6c..8bf5627f545 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # qiskit.quantum\_info.OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ Euler parameters are used. @@ -106,7 +106,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer ### basis - + The decomposition basis. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.mdx index 8d9c60b9fe6..b8aacd8dad4 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # qiskit.quantum\_info.Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -102,7 +102,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -150,13 +150,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -221,7 +221,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -259,7 +259,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -293,7 +293,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -339,7 +339,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.mdx index dee7440785f..53925f8bb91 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # qiskit.quantum\_info.PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.mdx index c89c32f8516..615234b1ef9 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # qiskit.quantum\_info.Pauli - + N-qubit Pauli operator. This class represents an operator $P$ from the full $n$-qubit *Pauli* group @@ -318,7 +318,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -407,7 +407,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -521,7 +521,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -533,7 +533,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -553,7 +553,7 @@ $$ ### phase - + Return the group phase exponent for the Pauli. @@ -581,13 +581,13 @@ $$ ### qargs - + Return the qargs for the operator. ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -632,7 +632,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -646,7 +646,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](#qiskit.quantum_info.Pauli.compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](#qiskit.quantum_info.Pauli.dot "qiskit.quantum_info.Pauli.dot"). @@ -807,13 +807,13 @@ $$ ### x - + The x vector for the Pauli. ### z - + The z vector for the Pauli. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.mdx index dd8ad8ba06c..e6baa24357b 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # qiskit.quantum\_info.PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -142,13 +142,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). @@ -200,7 +200,7 @@ $$ ### array - + The underlying boolean array. @@ -327,7 +327,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -410,7 +410,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -501,7 +501,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -535,7 +535,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -565,13 +565,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.mdx index a5a97ea9722..599df402489 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # qiskit.quantum\_info.Quaternion - + A class representing a Quaternion. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.mdx index 44802a1fa84..1161803daac 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # qiskit.quantum\_info.ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -79,13 +79,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeff - + Return the coefficient @@ -133,7 +133,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,7 +190,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -220,7 +220,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### qargs - + Return the qargs for the operator. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.mdx index e9bb387e501..43219c97c67 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # qiskit.quantum\_info.SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -91,13 +91,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeffs - + Return the Pauli coefficients. @@ -145,7 +145,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,13 +190,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -283,7 +283,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -317,7 +317,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### qargs - + Return the qargs for the operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### rtol - + Default relative tolerance parameter for float comparisons. @@ -372,13 +372,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### size - + The number of Pauli of Pauli terms in the operator. ### table - + Return the the PauliTable. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.mdx index 051e361d3a5..0db008da293 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # qiskit.quantum\_info.StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -156,13 +156,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). @@ -216,7 +216,7 @@ $$ ### array - + The underlying boolean array. @@ -354,7 +354,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -446,7 +446,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -549,7 +549,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -561,13 +561,13 @@ $$ ### pauli - + Return PauliTable ### phase - + Return phase vector @@ -595,7 +595,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -625,13 +625,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.mdx index 07210dd6300..5d29189579b 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # qiskit.quantum\_info.Statevector - + Statevector class Initialize a statevector object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.Statevector ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.Statevector ### data - + Return data. ### dim - + Return total state dimension. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -275,7 +275,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -360,7 +360,7 @@ python_api_name: qiskit.quantum_info.Statevector ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -504,7 +504,7 @@ python_api_name: qiskit.quantum_info.Statevector ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.mdx index 10c726b40f5..725541e1e14 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # qiskit.quantum\_info.Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -114,7 +114,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -166,13 +166,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -247,7 +247,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -285,7 +285,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -315,7 +315,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.mdx index 04338e9cf8e..91a65b95a30 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # qiskit.quantum\_info.SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 585d2b7b061..df78f8c51e5 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # qiskit.quantum\_info.TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.25/qiskit.result.Counts.mdx b/docs/api/qiskit/0.25/qiskit.result.Counts.mdx index 5831bf958c9..dfc594b5039 100644 --- a/docs/api/qiskit/0.25/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.25/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # qiskit.result.Counts - + A class to store a counts result from a circuit execution. Build a counts object diff --git a/docs/api/qiskit/0.25/qiskit.result.Result.mdx b/docs/api/qiskit/0.25/qiskit.result.Result.mdx index d44379b7084..e6d211777b0 100644 --- a/docs/api/qiskit/0.25/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.25/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # qiskit.result.Result - + Model for Results. ### backend\_name @@ -124,7 +124,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.25/qiskit.result.ResultError.mdx index e250fb23a88..0fd70dbb09b 100644 --- a/docs/api/qiskit/0.25/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.25/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.mdx index ab85076a420..4128437aeeb 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # qiskit.scheduler.ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.mdx index 27d9febaa5d..81451cc6f50 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # qiskit.transpiler.AnalysisPass - + An analysis pass: change property set, not DAG. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.mdx index f3513b34883..1f57c22118a 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # qiskit.transpiler.CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### distance\_matrix - + Return the distance matrix for the coupling map. @@ -133,25 +133,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### is\_symmetric - + Test if the graph is symmetric. Return True if symmetric, False otherwise @@ -207,7 +207,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### physical\_qubits - + Returns a sorted list of physical\_qubits diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.mdx index 246e3c2b753..143c7f14c71 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # qiskit.transpiler.FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.mdx index 5402b16609b..192aa4b068e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # qiskit.transpiler.FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.mdx index 54a1f8f3805..26dcb48f808 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # qiskit.transpiler.FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.mdx index 4a2329edcfb..8c31bda65f1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # qiskit.transpiler.InstructionDurations - + Helper class to provide durations of instructions for scheduling. It stores durations (gate lengths) and dt to be used at the scheduling stage of transpiling. It can be constructed from `backend` or `instruction_durations`, which is an argument of `transpile()`. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.Layout.mdx index d3a9aa839fa..021d615fdc6 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # qiskit.transpiler.Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -135,7 +135,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.mdx index d4d660772d1..c0d1088947b 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # qiskit.transpiler.PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.mdx index 230818965be..c6bd129c327 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # qiskit.transpiler.PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.mdx index a3115e25f10..61334a1ff05 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # qiskit.transpiler.PropertySet - + A default dictionary-like object ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.mdx index ac664e71627..2b453ee2c63 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # qiskit.transpiler.TransformationPass - + A transformation pass: change DAG, not property set. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.mdx index 2ec9052b1b9..ea4d333a912 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.mdx index a97f0a76b52..78f17c62b2e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.mdx index dad51e462f2..56892c05a47 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # qiskit.transpiler.passes.ALAPSchedule - + ALAP Scheduling. ALAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.mdx index e99b9ec0bbf..1a08de4dec9 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # qiskit.transpiler.passes.ASAPSchedule - + ASAP Scheduling. ASAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.mdx index b620fafa85d..9c9acce6352 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # qiskit.transpiler.passes.ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 15919b00dfc..bf49e66d4b1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # qiskit.transpiler.passes.BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.mdx index f38dc741ff3..02dd5d86ccc 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # qiskit.transpiler.passes.BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.mdx index 2b63c4cf378..3d642698549 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # qiskit.transpiler.passes.BasisTranslator - + Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. This pass operates in several steps: @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.mdx index 7503e8a4690..b9e24361d31 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # qiskit.transpiler.passes.CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.mdx index 9fd094457b2..f0b70609883 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # qiskit.transpiler.passes.CXCancellation - + Cancel back-to-back cx gates in dag. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.mdx index 34c871833d3..2d271a2bff4 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # qiskit.transpiler.passes.CXDirection - + Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. GateDirection pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.mdx index e667de9216d..a9b9918cb9b 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # qiskit.transpiler.passes.CheckCXDirection - + Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.mdx index f6510901f47..1ccb478b0f8 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # qiskit.transpiler.passes.CheckGateDirection - + Check if the two-qubit gates follow the right direction with respect to the coupling map. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.mdx index d6377cd2b8d..4bf3ed3ade9 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # qiskit.transpiler.passes.CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.mdx index 38255168c0e..5d39dd2bf04 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # qiskit.transpiler.passes.Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to property\_set as a dictionary of the form: @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.mdx index 9ef9b0d91df..244d8076fc5 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # qiskit.transpiler.passes.CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.mdx index fe5e7136155..75a0384281c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # qiskit.transpiler.passes.CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 43236b08928..3d3d468d1a4 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # qiskit.transpiler.passes.ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.mdx index 9408bb28f04..6bf971c0bae 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # qiskit.transpiler.passes.CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.mdx index acde255c6dd..41e9e46899f 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # qiskit.transpiler.passes.CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index e81aa1e1f2e..b6e2e15a0ac 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # qiskit.transpiler.passes.CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. @@ -216,7 +216,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -230,7 +230,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.mdx index d7439329702..80690c14816 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # qiskit.transpiler.passes.DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.mdx index 243679d198b..08f525f0379 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # qiskit.transpiler.passes.DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.mdx index cb71701d9b4..985084c6131 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # qiskit.transpiler.passes.Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.mdx index 3b877f5d3cf..00644d786ac 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # qiskit.transpiler.passes.DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.mdx index 1407152212d..a8ed13af4eb 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # qiskit.transpiler.passes.Depth - + Calculate the depth of a DAG circuit. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e32e846b624..9a5cdfa7d81 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # qiskit.transpiler.passes.EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.mdx index 9d83ac7e79b..fdba1fade22 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # qiskit.transpiler.passes.FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 035d7b87fb8..8b34c584905 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # qiskit.transpiler.passes.FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.mdx index 1de86ce793b..36648a24aef 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # qiskit.transpiler.passes.GateDirection - + Modify asymmetric gates to match the hardware coupling direction. This pass makes use of the following identities: @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.mdx index b453a21a63d..755fd759005 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # qiskit.transpiler.passes.Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.mdx index dd4c07bfe2c..c28e00b7e0d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # qiskit.transpiler.passes.LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 1efdb3e8659..527fe9f42e2 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # qiskit.transpiler.passes.MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 0fe1486f40a..e8f2223c7b0 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # qiskit.transpiler.passes.NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.mdx index d1b67c0a487..2c1222ddf99 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # qiskit.transpiler.passes.NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.mdx index 9b24675e825..767990f30bd 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # qiskit.transpiler.passes.Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index ae009c4f21e..4856eab18db 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # qiskit.transpiler.passes.Optimize1qGatesDecomposition - + Optimize chains of single-qubit gates by combining them into a single gate. Optimize1qGatesDecomposition initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 46ea4bf5823..af8e1246a1d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # qiskit.transpiler.passes.RZXCalibrationBuilder - + Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). Initializes a RZXGate calibration builder. @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -84,7 +84,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 05ecc6af7c5..b709e0df4cc 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 8675f915984..544b2c169a9 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # qiskit.transpiler.passes.RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 1d330a94c68..30e2e8cb627 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # qiskit.transpiler.passes.RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.mdx index 96b47bc92b3..482686be9a1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # qiskit.transpiler.passes.SabreLayout - + Choose a Layout via iterative bidirectional routing of the input circuit. Starting with a random initial Layout, the algorithm does a full routing of the circuit (via the routing\_pass method) to end up with a final\_layout. This final\_layout is then used as the initial\_layout for routing the reverse circuit. The algorithm iterates a number of times until it finds an initial\_layout that reduces full routing cost. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.mdx index 2c4048bb9e5..2e1ea7666fd 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # qiskit.transpiler.passes.SabreSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of the SWAP-based heuristic search from the SABRE qubit mapping paper \[1] (Algorithm 1). The heuristic aims to minimize the number of lossy SWAPs inserted and the depth of the circuit. @@ -124,7 +124,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -132,7 +132,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.mdx index 4f07c35e469..c129fa18359 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # qiskit.transpiler.passes.SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.mdx index 1cc78e62958..9724f37f99e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # qiskit.transpiler.passes.Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.mdx index fa0c8d61405..60dbbf22504 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # qiskit.transpiler.passes.StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.mdx index ee9a49ac213..4ac6d9921c4 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # qiskit.transpiler.passes.TemplateOptimization - + Class for the template optimization pass. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.mdx index 446a5bdd47a..7d7b18a389c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # qiskit.transpiler.passes.TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.mdx index 9f9436bd943..300a570ad78 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # qiskit.transpiler.passes.UnitarySynthesis - + Synthesize gates according to their basis gates. Synthesize unitaries over some basis gates. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f3ef3c0cc34..8f3901e44a2 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # qiskit.transpiler.passes.Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 4db4a49e651..e48b1b53bc6 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # qiskit.transpiler.passes.UnrollCustomDefinitions - + Unrolls instructions with custom definitions. Unrolls instructions with custom definitions. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.mdx index 8080d5ce674..76547951fcb 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # qiskit.transpiler.passes.Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.mdx index 7b5f85bb346..81f5ce6b7cb 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # qiskit.transpiler.passes.Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.mdx index dbb7bf7d1c5..2133ce1dd4f 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # qiskit.utils.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.utils.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.utils.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.utils.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.utils.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.utils.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.utils.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.mdx index ecb289e5ad6..daa77f3d557 100644 --- a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.mdx index 335265d4046..34e2e716b0d 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 054aacd5461..19e5fff1228 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # qiskit.visualization.pulse\_v2.IQXDebugging - + Pulse stylesheet for pulse programmers. Show details of instructions. \# TODO: add more generators diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.mdx index a04d7e247b5..efea44d0361 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # qiskit.visualization.pulse\_v2.IQXSimple - + Simple pulse stylesheet without channel notation. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.mdx index 9255beb4f13..6601a544500 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # qiskit.visualization.pulse\_v2.IQXStandard - + Standard pulse stylesheet. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.mdx index bb00e78d3b3..43aeb361123 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # qiskit.visualization.qcstyle.DefaultStyle - + Creates a Default Style dictionary **Style Dict Details** diff --git a/docs/api/qiskit/0.26/logging.mdx b/docs/api/qiskit/0.26/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.26/logging.mdx +++ b/docs/api/qiskit/0.26/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.mdx index ced373b54da..7a1fd62186e 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.mdx index 9990867277d..74a6cdcbed6 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # qiskit.algorithms.AmplificationProblem - + The amplification problem is the input to amplitude amplification algorithms, like Grover. This class contains all problem-specific information required to run an amplitude amplification algorithm. It minimally contains the Grover operator. It can further hold some post processing on the optimal bitstring. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### is\_good\_state - + Check whether a provided bitstring is a good state or not. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### objective\_qubits - + The indices of the objective qubits. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### oracle - + Return the oracle. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### state\_preparation - + Get the state preparation operator $\mathcal{A}$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.mdx index ae78b99d326..6bc43ac06b0 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # qiskit.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -76,7 +76,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -101,7 +101,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** @@ -184,7 +184,7 @@ $$ ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.mdx index 831d8c595ce..61150b6a242 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # qiskit.algorithms.AmplitudeEstimationResult - + The `AmplitudeEstimation` result object. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### measurements - + Return the measurements as integers with their measurement probability. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle - + Return the MLE for the amplitude, in $\[0, 1]\$. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle\_processed - + Return the post-processed MLE for the amplitude. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_evaluation\_qubits - + Returns the number of evaluation qubits. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples - + Return the measurement samples with their measurement probability. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples\_processed - + Return the post-processed measurement samples with their measurement probability. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.mdx index 41de4a7b71b..f590f52119e 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # qiskit.algorithms.AmplitudeEstimator - + The Amplitude Estimation interface. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.mdx index c79948487f1..b4ca7246bcf 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # qiskit.algorithms.AmplitudeEstimatorResult - + The results object for amplitude estimation algorithms. ### \_\_init\_\_ @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.mdx index 75703feaa0d..97591d96c87 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # qiskit.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.mdx index 3c4d59fed31..6c46a5663d3 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # qiskit.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.mdx index a5fdcba53b2..bbf8f361d15 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # qiskit.algorithms.EstimationProblem - + The estimation problem is the input to amplitude estimation algorithm. This class contains all problem-specific information required to run an amplitude estimation algorithm. That means, it minimally contains the state preparation and the specification of the good state. It can further hold some post processing on the estimation of the amplitude or a custom Grover operator. @@ -52,7 +52,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### is\_good\_state - + Checks whether a bitstring represents a good state. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 45763fc1df3..1897fb4f7fd 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # qiskit.algorithms.FasterAmplitudeEstimation - + The Faster Amplitude Estimation algorithm. The Faster Amplitude Estimation (FAE) \[1] algorithm is a variant of Quantum Amplitude Estimation (QAE), where the Quantum Phase Estimation (QPE) by an iterative Grover search, similar to \[2]. @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index ba826fed8cc..6aa96221f17 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # qiskit.algorithms.FasterAmplitudeEstimationResult - + The result object for the Faster Amplitude Estimation algorithm. ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_first\_state\_steps - + Return the number of steps taken in the first step of algorithm. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_steps - + Return the total number of steps taken in the algorithm. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### success\_probability - + Return the success probability of the algorithm. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.Grover.mdx index 8a8ee0b22e3..acf51a042e9 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # qiskit.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -159,7 +159,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -178,7 +178,7 @@ $$ ### quantum\_instance - + Get the quantum instance. :rtype: `Optional`\[`QuantumInstance`] :returns: The quantum instance used to run this algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.mdx index 30550458714..f2db1318e6d 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # qiskit.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.GroverResult ### assignment - + The post-processed value of the most likely bitstring. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.GroverResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.GroverResult ### iterations - + All the powers of the Grover operator that have been tried. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.GroverResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.GroverResult ### oracle\_evaluation - + Whether the classical oracle evaluation of the top measurement was True or False. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.GroverResult ### top\_measurement - + The most frequently measured output as bitstring. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.HHL.mdx index df27335e92c..0a4b266d298 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # qiskit.algorithms.HHL - + 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. A system of linear equations is called $s$-sparse if $A$ has at most $s$ non-zero entries per row or column. Solving an $s$-sparse system of size $N$ with a classical computer requires $\mathcal{ O }(Ns\kappa\log(1/\epsilon))$ running time using the conjugate gradient method. Here $\kappa$ denotes the condition number of the system and $\epsilon$ the accuracy of the approximation. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.HHL ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.HHL ### quantum\_instance - + Get the quantum instance. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.HHL ### scaling - + The scaling of the solution vector. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index ade2cd90c7e..bfbb740e847 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # qiskit.algorithms.HamiltonianPhaseEstimation - + Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index f416f931b6e..61cb6ff02df 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # qiskit.algorithms.HamiltonianPhaseEstimationResult - + Store and manipulate results from running HamiltonianPhaseEstimation. This API of this class is nearly the same as PhaseEstimatorResult, differing only in the presence of an additional keyword argument in the methods. If scaled is False, then the phases are not translated and scaled to recover the eigenvalues of the Hamiltonian. Instead phi in $[0, 1)$ is returned, as is the case when then unitary is not derived from a Hamiltonian. @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_eigenvalue - + The most likely eigenvalue of the Hamiltonian. This method calls most\_likely\_phase and scales the result to obtain an eigenvalue. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_phase - + The most likely phase of the unitary corresponding to the Hamiltonian. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 090ee754a8c..79583ec9f0b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # qiskit.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### epsilon\_target - + Returns the target precision `epsilon_target` of the algorithm. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 385c82d1cc9..28a433a2dc1 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # qiskit.algorithms.IterativeAmplitudeEstimationResult - + The `IterativeAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### alpha - + Return the confidence level $\alpha$. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated - + Return the estimated half-width of the confidence interval. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated\_processed - + Return the post-processed estimated half-width of the confidence interval. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_target - + Return the target half-width of the confidence interval. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimate\_intervals - + Return the confidence intervals for the estimate in each iteration. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### powers - + Return the powers of the Grover operator in each iteration. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### ratios - + Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.mdx index d8a1825a82f..7aef2efe41f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # qiskit.algorithms.LinearSolver - + An abstract class for linear system solvers in Qiskit. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.mdx index da53deb9a45..f8028c4f5bc 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # qiskit.algorithms.LinearSolverResult - + A base class for linear systems results. The linear systems algorithms return an object of the type `LinearSystemsResult` with the information about the solution obtained. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### circuit\_results - + return the results from the circuits **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### euclidean\_norm - + return the euclidean norm if the algorithm knows how to calculate it **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### observable - + return the (list of) calculated observable(s) **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### state - + return either the circuit that prepares the solution or the solution as a vector **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c02655ea5b5..6acac4aa414 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -65,7 +65,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 0184cc3fc4d..685be864272 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + The `MaximumLikelihoodAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### evaluation\_schedule - + Return the evaluation schedule for the powers of the Grover operator. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### fisher\_information - + Return the Fisher information for the estimated amplitude. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### good\_counts - + Return the percentage of good counts per circuit power. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### minimizer - + Return the minimizer used for the search of the likelihood function. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### theta - + Return the estimate for the angle $\theta$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.mdx index f1edaaf58a1..c1e062c5420 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # qiskit.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.mdx index 228b97dc194..7e28b33e762 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # qiskit.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.mdx index 90fe56f19ab..97b777300bb 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # qiskit.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.mdx index cd454456bf9..ddbb4aa2e80 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # qiskit.algorithms.NumPyLinearSolver - + The Numpy Linear Solver algorithm (classical). This linear system solver computes the exact value of the given observable(s) or the full solution vector if no observable is specified. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 56110e2bd3d..e865a35ee25 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # qiskit.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.mdx index a03600dc287..08b4c38b96b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # qiskit.algorithms.PhaseEstimation - + Run the Quantum Phase Estimation (QPE) algorithm. This runs QPE with a multi-qubit register for reading the phases \[1] of input states. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.mdx index 84e91d4e94b..ae3df3f0dc6 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # qiskit.algorithms.PhaseEstimationResult - + Store and manipulate results from running PhaseEstimation. This class is instantiated by the PhaseEstimation class, not via user code. The PhaseEstimation class generates a list of phases and corresponding weights. Upon completion it returns the results as an instance of this class. The main method for accessing the results is filter\_phases. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### circuit\_result - + Return the result object returned by running the QPE circuit (on hardware or simulator). This is useful for inspecting and troubleshooting the QPE algorithm. @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### most\_likely\_phase - + Return the estimated phase as a number in $[0.0, 1.0)$. 1.0 corresponds to a phase of $2\pi$. It is assumed that the input vector is an eigenvector of the unitary so that the peak of the probability density occurs at the bit string that most closely approximates the true phase. @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### phases - + Return all phases and their frequencies computed by QPE. This is an array or dict whose values correspond to weights on bit strings. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.mdx index de8b5fe52b2..c4adc1fd63a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # qiskit.algorithms.PhaseEstimationScale - + Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. The `bound` is set when constructing this class. Then the method `scale` is used to find the factor by which to scale the operator. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### scale - + Return the Hamiltonian scaling factor. Return the scale factor by which a Hermitian operator must be multiplied so that the phase of the corresponding unitary is restricted to $[-\pi, \pi]$. This factor is computed from the bound on the absolute values of the eigenvalues of the operator. The methods `scale_phase` and `scale_phases` are used recover the eigenvalues corresponding the original (unscaled) Hermitian operator. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.mdx index 3da263a7e93..2522b7d9fef 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # qiskit.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.QAOA ### ansatz - + Returns the ansatz **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -314,13 +314,13 @@ python_api_name: qiskit.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.Shor.mdx index da7d0f79492..03796b7385f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # qiskit.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.mdx index dd2900a81c7..28195990185 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # qiskit.algorithms.ShorResult - + Shor Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.ShorResult ### factors - + returns factors **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.ShorResult ### successful\_counts - + returns successful counts **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.ShorResult ### total\_counts - + returns total counts **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.VQE.mdx index 77b26214c14..5fa6a80751b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # qiskit.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a quantum algorithm that uses a variational technique to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.VQE ### ansatz - + Returns the ansatz **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.algorithms.VQE ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.mdx index fc74e1e22c1..675814e2e5e 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # qiskit.algorithms.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.mdx index d7346c7e104..daab840bb70 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # qiskit.algorithms.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,67 +128,67 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -246,13 +246,13 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.mdx index fcb0a2f613b..964e41e9f92 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # qiskit.algorithms.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.mdx index 944643038d4..306552d8a39 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # qiskit.algorithms.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.mdx index 2fae01a4b4f..bcde425a455 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # qiskit.algorithms.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.mdx index 0c48de21807..3cd90f0363b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # qiskit.algorithms.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.mdx index c5ec1cdb5de..c51d642ba16 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # qiskit.algorithms.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 7cf901ff8a2..464d9d03db8 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # qiskit.algorithms.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.mdx index 4f7f71ce569..29ad20d828b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # qiskit.algorithms.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.mdx index 2a12f8e9418..3f40387487d 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # qiskit.algorithms.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -146,67 +146,67 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -338,13 +338,13 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.mdx index 70d5a6fd704..a8f17c14123 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # qiskit.algorithms.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.mdx index 4bcfd949f8b..eb30e1dbefe 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # qiskit.algorithms.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.mdx index e57f4129113..0085bc49ce9 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # qiskit.algorithms.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index f4f0c2c9618..cc917aa2ea2 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # qiskit.algorithms.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.mdx index c0fdb812a42..e6ac4b40930 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # qiskit.algorithms.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.mdx index 122975bb292..4022783ae9c 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # qiskit.algorithms.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 32eb1868947..fd14ed2b84b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # qiskit.algorithms.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.mdx index e43ba54fb81..664d301c356 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # qiskit.algorithms.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.mdx index 0e3cb6b9614..33547a16dd4 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # qiskit.algorithms.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.mdx index 122a5acebd2..7345f066bba 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # qiskit.algorithms.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.mdx index 448d7b75c14..f345b079737 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # qiskit.algorithms.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.mdx index 0293256115b..40414b7f195 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # qiskit.algorithms.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA \[1] is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -96,13 +96,13 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -151,7 +151,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -172,67 +172,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -286,13 +286,13 @@ $$ ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.mdx index 012053edb16..ae1dfb33859 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # qiskit.algorithms.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.26/qiskit.aqua.AquaError.mdx index cfb60f8d6da..b014309ee47 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.mdx index 537435976d9..ed6e75058c4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.mdx index 2915686d9f2..ba2584ac7ca 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # qiskit.aqua.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.aqua.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index fd56a255ecf..6a35fae521a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # qiskit.aqua.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -91,7 +91,7 @@ $$ ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -109,7 +109,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -161,7 +161,7 @@ $$ ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -177,7 +177,7 @@ $$ ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -219,7 +219,7 @@ $$ ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -251,7 +251,7 @@ $$ ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -273,7 +273,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -283,7 +283,7 @@ $$ ### random - + Return a numpy random. @@ -322,7 +322,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 5b9f724ff8a..873ab10b775 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult - + AmplitudeEstimationAlgorithm Result. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### a\_estimation - + return a\_estimation **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### estimation - + return estimation **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index de7e30b69ad..43e1456342e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # qiskit.aqua.algorithms.AmplitudeEstimationResult - + AmplitudeEstimation Result. ### \_\_init\_\_ @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_samples - + return a\_samples **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### circuit\_result - + return circuit result **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_a\_samples - + return mapped\_a\_samples **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_values - + return mapped\_values **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### max\_probability - + return max\_probability **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### ml\_value - + returns ml\_value **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mle - + return mle **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### probabilities - + return probabilities **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### shots - + return shots **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### y\_measurements - + return y\_measurements **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.mdx index ae4911c2635..44903b2aaf5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # qiskit.aqua.algorithms.BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index ba3f4257eed..80bf2b8b21c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # qiskit.aqua.algorithms.ClassicalAlgorithm - + Base class for Classical Algorithms. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index b99c7789762..fab4625a50d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # qiskit.aqua.algorithms.ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### random - + Return a numpy random. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### solution - + return solution diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.mdx index 61f63f2b650..01f87c17ba6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # qiskit.aqua.algorithms.DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.mdx index 0f903e2a1ae..045557279ff 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # qiskit.aqua.algorithms.EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.mdx index fb7faece3bf..547838264e3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # qiskit.aqua.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.mdx index 33c8bb26b35..9dfaf18e713 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # qiskit.aqua.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.mdx index 5f097a1b694..a8e75faf3b8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # qiskit.aqua.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -145,7 +145,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -174,7 +174,7 @@ $$ ### grover\_operator - + Returns grover\_operator. **Return type** @@ -202,7 +202,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -239,7 +239,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -249,7 +249,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.mdx index eff6a058332..9dcb420e0d8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # qiskit.aqua.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### assignment - + return assignment **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### circuit - + return circuit **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### measurement - + returns measurement **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### oracle\_evaluation - + return oracle evaluation **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### top\_measurement - + return top measurement **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.mdx index f7b3190b727..b4aaeccb6fe 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # qiskit.aqua.algorithms.HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -94,7 +94,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -122,7 +122,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -141,7 +141,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -160,7 +160,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** @@ -183,7 +183,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -193,7 +193,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.mdx index 3efe7dde0ae..e7382b96c50 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # qiskit.aqua.algorithms.HHLResult - + HHL Result. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### circuit\_info - + return circuit info **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### matrix - + return matrix **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### output - + return output **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### probability\_result - + return probability result **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### solution - + return solution **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### vector - + return vector **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.mdx index 959b84047b5..3dd5a16d8d2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # qiskit.aqua.algorithms.IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### random - + Return a numpy random. @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index d441266b937..85fba18f286 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # qiskit.aqua.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -166,7 +166,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -276,7 +276,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -286,7 +286,7 @@ $$ ### random - + Return a numpy random. @@ -325,7 +325,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index 5aa96c6cb2a..748d7af8f53 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult - + IterativeAmplitudeEstimation Result. ### \_\_init\_\_ @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_intervals - + return a\_intervals **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### actual\_epsilon - + return mle **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### alpha - + return alpha **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### powers - + return powers **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### ratios - + return ratios **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + return theta\_intervals **Return type** @@ -232,7 +232,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### value\_confidence\_interval - + return value\_confidence\_interval **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.mdx index fe9b12ced34..e630d32e5a5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # qiskit.aqua.algorithms.LinearsolverResult - + Linear solver Result. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 5956f87cf12..f7a68685d01 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -265,7 +265,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -275,7 +275,7 @@ $$ ### random - + Return a numpy random. @@ -314,7 +314,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 906324e009b..5b52cbed115 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + MaximumLikelihoodAmplitudeEstimation Result. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### a\_estimation - + return a\_estimation **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### circuit\_results - + return circuit results **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### confidence\_interval - + return confidence\_interval **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### estimation - + return estimation **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fisher\_information - + return fisher\_information **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### theta - + returns theta **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.mdx index b6c140be94f..8029dc3fd04 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # qiskit.aqua.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 2bde057521c..9d12d47da10 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # qiskit.aqua.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 3ef6ca0060a..e4e7dccc595 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # qiskit.aqua.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + Return the operator. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### random - + Return a numpy random. @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 4137b98fa34..ab6429e5780 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # qiskit.aqua.algorithms.NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 566acdf6ce2..2cd0965e0a8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # qiskit.aqua.algorithms.NumPyLSsolverResult - + Numpy LinearSystem Result. ### \_\_init\_\_ @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### eigvals - + return eigvals **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7d9471a3152..da3bb41909b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # qiskit.aqua.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### random - + Return a numpy random. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.mdx index 6db057482a9..9d457d3345b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # qiskit.aqua.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### random - + Return a numpy random. @@ -381,13 +381,13 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -403,7 +403,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.mdx index bde7b216d3e..a4640bfb4db 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # qiskit.aqua.algorithms.QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### d\_loss - + Returns discriminator loss **Return type** @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### discriminator - + Returns discriminator ### g\_loss - + Returns generator loss **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### generator - + Returns generator @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** @@ -154,13 +154,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### random - + Return a numpy random. ### rel\_entr - + Returns relative entropy between target and trained distribution **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### seed - + Returns random seed @@ -236,7 +236,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### tol\_rel\_ent - + Returns tolerance for relative entropy diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.mdx index 6c9e148847b..58d9d250342 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # qiskit.aqua.algorithms.QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### random - + Return a numpy random. @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.mdx index 32742d729af..26b863c939f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # qiskit.aqua.algorithms.QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### backend - + Returns backend. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** @@ -211,13 +211,13 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 8d7434818c7..8fff26c125c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # qiskit.aqua.algorithms.QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.mdx index 8a1addbcac2..aa0bdfe3ce4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # qiskit.aqua.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.mdx index 02fd7514957..52cee62018b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # qiskit.aqua.algorithms.Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.mdx index 8442c69cdc2..2b3cd189861 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # qiskit.aqua.algorithms.SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### class\_to\_label - + returns class to label ### label\_to\_class - + returns label to class @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.mdx index e407ef511ec..dd6068fd946 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # qiskit.aqua.algorithms.VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### class\_to\_label - + returns class to label @@ -161,13 +161,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### datapoints - + return data points ### feature\_map - + Return the feature map. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### label\_to\_class - + returns label to class @@ -261,13 +261,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -308,13 +308,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### random - + Return a numpy random. ### ret - + returns result @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### test\_dataset - + returns test dataset @@ -400,13 +400,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### training\_dataset - + returns training dataset ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.mdx index 5858de9ca78..3fa09a819db 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # qiskit.aqua.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -256,7 +256,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### random - + Return a numpy random. @@ -359,13 +359,13 @@ python_api_name: qiskit.aqua.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.mdx index b0b7def3bba..8f044e16bee 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # qiskit.aqua.circuits.CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.CNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.CNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.mdx index 60722895645..ed1b17ee960 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # qiskit.aqua.circuits.DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.DNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.DNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.mdx index 39accb7c113..dc04485582a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # qiskit.aqua.circuits.ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.ESOP ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.ESOP ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index fe33c11495f..a79c9488078 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # qiskit.aqua.circuits.PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### ancillary\_register - + returns ancillary register ### auxiliary\_register - + returns auxiliary register @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### state\_register - + returns state register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.mdx index c67dcb3cd56..a9d6dfe55ee 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # qiskit.aqua.circuits.StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.mdx index 5b275bb3535..263261e906a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # qiskit.aqua.circuits.WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -161,31 +161,31 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits ### num\_carry\_qubits - + returns num carry qubits ### num\_state\_qubits - + returns num state qubits ### num\_sum\_qubits - + returns num sum qubits ### num\_target\_qubits - + Returns the number of target qubits @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### weights - + returns weights diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.mdx index 570312bdb3b..c841ee04b7f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # qiskit.aqua.components.eigs.Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.mdx index 1d94727e0b7..a000ed40f95 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # qiskit.aqua.components.eigs.EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 4b489a699f9..b4939e34896 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # qiskit.aqua.components.feature\_maps.FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -58,31 +58,31 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index a9409dc9d07..4ca15fe4605 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # qiskit.aqua.components.feature\_maps.RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -69,31 +69,31 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.mdx index 6510698a98a..aff22f669fe 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # qiskit.aqua.components.initial\_states.Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.mdx index 1c371ffad98..8dcee7e91fb 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # qiskit.aqua.components.initial\_states.InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -34,11 +34,11 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### bitstr - + ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.mdx index 57a9002c711..509eca8b2e4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # qiskit.aqua.components.initial\_states.VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.mdx index b51ef7cc33e..cd6b622ed1f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # qiskit.aqua.components.initial\_states.Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 23d339ab751..a6cc6497dc0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # qiskit.aqua.components.multiclass\_extensions.AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index cd12c28cb2c..0d57860c84d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # qiskit.aqua.components.multiclass\_extensions.ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 2129162570a..bbdabbf6272 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # qiskit.aqua.components.multiclass\_extensions.MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index 33bb508dbbc..865bfb28bc6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # qiskit.aqua.components.multiclass\_extensions.OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index a45c778e813..2527bbad171 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # qiskit.aqua.components.neural\_networks.DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index f6cdba6d88e..73ee445876a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # qiskit.aqua.components.neural\_networks.GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### parameter\_values - + Get parameter values from the generator **Raises** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_discriminator - + Set discriminator network. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 40fb17633a9..f3848f3ef64 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # qiskit.aqua.components.neural\_networks.NumPyDiscriminator - + Discriminator based on NumPy **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 823ede5c275..0a05effe1d3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # qiskit.aqua.components.neural\_networks.PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index f732cfcf18a..4c2fae2b47c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # qiskit.aqua.components.neural\_networks.QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### discriminator - + Get discriminator. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### optimizer - + Get optimizer. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### parameter\_values - + Get parameter values from the quantum generator **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### seed - + Get seed. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.mdx index ef0b3809602..d543488872d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # qiskit.aqua.components.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.mdx index 0731c83bfb1..5f0039e33cf 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # qiskit.aqua.components.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,67 +130,67 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -248,13 +248,13 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.mdx index fd229abcf44..2fe30b6a348 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # qiskit.aqua.components.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.mdx index c5fd74e0b3d..55991c45ef6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # qiskit.aqua.components.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.mdx index 499e3a0dcc4..cf92c2aa1f5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # qiskit.aqua.components.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.mdx index 4038d116bc6..6af8a69bb30 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # qiskit.aqua.components.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8590001ac6e..c366c241344 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # qiskit.aqua.components.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 5604b313590..24b96919ef5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # qiskit.aqua.components.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.mdx index 469f5723bea..2104a1dfbb2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # qiskit.aqua.components.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.mdx index 333de2bed74..f5709158210 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # qiskit.aqua.components.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -127,7 +127,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -148,67 +148,67 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -340,13 +340,13 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.mdx index 397d9b5d42f..6189dd64722 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # qiskit.aqua.components.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.mdx index dba0fd9ba85..787d714a167 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # qiskit.aqua.components.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index c71bf7bd60b..48781e0581f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # qiskit.aqua.components.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index e6d33b5e282..135243451c7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # qiskit.aqua.components.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.mdx index 8227d7f2657..89bf21aadaf 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # qiskit.aqua.components.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.mdx index 0d1f3c01877..e9ac0f94c38 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # qiskit.aqua.components.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 275f472c907..bee2a0085c6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # qiskit.aqua.components.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.mdx index ad3ccd73021..560a4a48ac2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # qiskit.aqua.components.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.mdx index 0aea4556549..46f960acb37 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # qiskit.aqua.components.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.mdx index 7a58312796e..dbf3bd6ae15 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # qiskit.aqua.components.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.mdx index f3811b85da2..bdbe0897f01 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # qiskit.aqua.components.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.mdx index d9e1bb08faf..b1b4f2a2d4f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # qiskit.aqua.components.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -123,67 +123,67 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -237,13 +237,13 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.mdx index 597a684e2ba..e7fc949f6c2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # qiskit.aqua.components.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index e3942f76ec3..85caa6d3eb4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # qiskit.aqua.components.oracles.CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. @@ -69,13 +69,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -93,13 +93,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 3c4f757da7f..225d8475579 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # qiskit.aqua.components.oracles.LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -102,13 +102,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.mdx index 4115a2a9516..db9a3fc404d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # qiskit.aqua.components.oracles.Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -42,17 +42,17 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit - + Construct the oracle circuit. **Returns** @@ -62,13 +62,13 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b568f4c946e..6e67e33a39a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # qiskit.aqua.components.oracles.TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -90,13 +90,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.mdx index 12733381322..24685415d29 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # qiskit.aqua.components.reciprocals.LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.mdx index 81ea9c033da..417d4781447 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # qiskit.aqua.components.reciprocals.LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 557c97bc0a2..738b9c885b1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # qiskit.aqua.components.reciprocals.Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 6a50517d42c..27020a2a802 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # qiskit.aqua.components.uncertainty\_models.BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -142,35 +142,35 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### p - + ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### probabilities - + returns probabilities @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 22f28459568..21814d6362d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # qiskit.aqua.components.uncertainty\_models.GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### dimension - + returns dimensions @@ -158,49 +158,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 8d3315a2130..5f2b33ad2a4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # qiskit.aqua.components.uncertainty\_models.LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index c0b41887189..51fef3b7216 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # qiskit.aqua.components.uncertainty\_models.MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index eeb289bbe79..5b097bc040f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # qiskit.aqua.components.uncertainty\_models.MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 528b48c7586..23cf44e5f64 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # qiskit.aqua.components.uncertainty\_models.MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### dimension - + returns dimensions @@ -154,49 +154,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 830531fd516..51c9f5cc508 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index b3e63aba43e..b160ede9953 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # qiskit.aqua.components.uncertainty\_models.MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### dimension - + returns dimensions @@ -153,49 +153,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 46c3114ba4b..2dd748bb414 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # qiskit.aqua.components.uncertainty\_models.NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index e526ca3b43f..afbc8f9571e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # qiskit.aqua.components.uncertainty\_models.UncertaintyModel - + The abstract Uncertainty Model ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index 10ecbbbfbed..69cadc04f36 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # qiskit.aqua.components.uncertainty\_models.UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -141,31 +141,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### probabilities - + returns probabilities @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index 5a533bc58a2..316c48d150c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # qiskit.aqua.components.uncertainty\_models.UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -149,31 +149,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### probabilities - + returns probabilities @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index a364b9274d4..cc7e1006e8b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # qiskit.aqua.components.uncertainty\_models.UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -144,31 +144,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### probabilities - + returns probabilities @@ -217,7 +217,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### values - + returns values diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index 1c741bf2770..c6ab224913b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # qiskit.aqua.components.uncertainty\_problems.MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index 0e99e008c48..8c02d908cb8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # qiskit.aqua.components.uncertainty\_problems.UncertaintyProblem - + The abstract Uncertainty Problem component. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 5ac5955c5f7..0eeb0cb862f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # qiskit.aqua.components.uncertainty\_problems.UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: @@ -156,7 +156,7 @@ $$ ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index ccb460fb0f1..4b9b92d7e2a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # qiskit.aqua.components.uncertainty\_problems.UnivariateProblem - + Univariate uncertainty problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 0678df8bfc8..7007118837f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # qiskit.aqua.components.variational\_forms.VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### parameter\_bounds - + Parameter bounds. **Returns** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -116,11 +116,11 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.mdx index 4787352dbf8..bc4da1df0d2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.OperatorBase # qiskit.aqua.operators.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -177,7 +177,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -223,13 +223,13 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -315,7 +315,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -333,7 +333,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -353,7 +353,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 933592cb462..7ebc23253d9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # qiskit.aqua.operators.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.mdx index 5baddfcd2da..34fb0135015 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # qiskit.aqua.operators.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.mdx index 7d7dd8b170e..fa26b966c60 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # qiskit.aqua.operators.converters.ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index fc1aa54d7cf..a0e101f50fc 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # qiskit.aqua.operators.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 898ddc4fdb9..e7b77dd00f0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # qiskit.aqua.operators.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index a427ad49246..10782a3f3c5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # qiskit.aqua.operators.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index e463579330b..3e5ea422e91 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # qiskit.aqua.operators.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 6671c0f0f55..c828cc94cad 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # qiskit.aqua.operators.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -318,7 +318,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 286379421e5..d956a66efe0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # qiskit.aqua.operators.evolutions.MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index fe260118b9c..b33caa97fda 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # qiskit.aqua.operators.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.mdx index a777c872bc0..1493bf248e3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # qiskit.aqua.operators.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.mdx index ca0e463ca78..86b630b7026 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # qiskit.aqua.operators.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.mdx index f15b03435a4..480f6d58bd3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # qiskit.aqua.operators.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index cf919be5d48..361cbcf46fb 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # qiskit.aqua.operators.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 5e1f161079f..e69c3dedc31 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # qiskit.aqua.operators.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index 6999acf26ea..51f3206af90 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # qiskit.aqua.operators.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index 8e7df6d553f..4f5d780842c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # qiskit.aqua.operators.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 6c707d3988a..2f2707fcc05 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # qiskit.aqua.operators.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index f371ab0f386..dd297a5dfb3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # qiskit.aqua.operators.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index b2d0f7f4fc6..dcd55e48373 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # qiskit.aqua.operators.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.mdx index f4ae2b360d4..eaa155c0007 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # qiskit.aqua.operators.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a5ed172688b..7a8b5fd47e6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # qiskit.aqua.operators.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 8c3cd57f155..d49eded58c7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # qiskit.aqua.operators.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.mdx index cd28266e80e..f35162560af 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # qiskit.aqua.operators.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.mdx index 6ce8fd8a006..c14b662068b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # qiskit.aqua.operators.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.mdx index d565bbe49b5..7f41eb6829f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # qiskit.aqua.operators.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.mdx index 228cd12c85b..e8a0930eb53 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # qiskit.aqua.operators.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.mdx index 523cf619b37..f9876785c80 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # qiskit.aqua.operators.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.mdx index 29a31c4ad41..d32a409297e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # qiskit.aqua.operators.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.mdx index 7b013ca4d6e..da7ce1abd05 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # qiskit.aqua.operators.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parametrized quantum state, where QFI is: @@ -93,7 +93,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -112,7 +112,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.mdx index 613712d91a6..bfc269a4012 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # qiskit.aqua.operators.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parametrized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index c2f2beb55c0..bb98926c622 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # qiskit.aqua.operators.legacy.LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. ### \_\_init\_\_ - + Constructor. @@ -43,65 +43,65 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### basis - + returns basis ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### name - + returns name ### num\_qubits - + Returns number of qubits for operator ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 8cc914ff1bb..33e330bfa3c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # qiskit.aqua.operators.legacy.MatrixOperator - + Operators relevant for quantum applications @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### atol - + return atol ### basis - + returns basis @@ -131,13 +131,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### dense\_matrix - + Getter of matrix in dense matrix form. ### dia\_matrix - + diagonal matrix @@ -229,19 +229,19 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### matrix - + Getter of matrix. ### name - + returns name ### num\_qubits - + number of qubits required for the operator. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.mdx index 924e12d688d..5de75ef72ea 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # qiskit.aqua.operators.legacy.PauliGraph - + Pauli Graph. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph ### grouped\_paulis - + Getter of grouped Pauli list. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index e95b8cffdc7..b093ac18b44 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -108,13 +108,13 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -349,7 +349,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -368,7 +368,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -392,7 +392,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### grouping\_func - + returns grouping function @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### kwargs - + returns kwargs @@ -438,19 +438,19 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### name - + returns name ### num\_groups - + returns number of groups ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -464,7 +464,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### paulis - + get paulis @@ -539,7 +539,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -607,7 +607,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** @@ -625,7 +625,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 410f6d99cf1..1d422f494e1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # qiskit.aqua.operators.legacy.WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -99,13 +99,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -340,7 +340,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -415,13 +415,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### name - + returns name ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -435,7 +435,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### paulis - + get paulis @@ -559,7 +559,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index c2ef9da6c81..143a95207d0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # qiskit.aqua.operators.legacy.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. **Returns** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -139,19 +139,19 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -182,13 +182,13 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### tapering\_values - + returns tapering values ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 4e03fb5a52f..e7ce512e2c8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # qiskit.aqua.operators.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.mdx index c47867a18b2..0a7693ab4c3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # qiskit.aqua.operators.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.mdx index 2cdc1ee7d9e..1cc90a4070e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # qiskit.aqua.operators.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.mdx index e746124092a..eed67051ce7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # qiskit.aqua.operators.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index 6a491e3279f..3177f692897 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # qiskit.aqua.operators.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -324,7 +324,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index ba012dc5fb2..5a627740ba5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # qiskit.aqua.operators.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -328,7 +328,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index c43d201e415..931a3f988b1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # qiskit.aqua.operators.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -346,7 +346,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 83a54c620f2..838e7612f3d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # qiskit.aqua.operators.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index cefc082b6de..dfa6ef23fad 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # qiskit.aqua.operators.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index 0919f90636a..b1f641beaab 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # qiskit.aqua.operators.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.mdx index 81bf9c2c4ac..61dea24e238 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # qiskit.aqua.operators.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 440aea8d541..ebf15d8e7cc 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # qiskit.aqua.operators.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.mdx index 9aedab6571c..08d0478bb5a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # qiskit.aqua.operators.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -304,7 +304,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 1a99e0ab803..46eadd524ac 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # qiskit.aqua.operators.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.mdx index 063b279fc6e..46cbc653ae5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # qiskit.aqua.utils.CircuitFactory - + Base class for CircuitFactories ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.mdx index deb6f41b8aa..d7d143ad6ac 100644 --- a/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # qiskit.assembler.RunConfig - + Class for Run Configuration. ### shots @@ -97,7 +97,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.mdx index ae81b901aae..d49bcf65352 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # qiskit.chemistry.BosonicOperator - + A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.mdx index 556c2a3ff8d..707ca90e5f4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # qiskit.chemistry.FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: @@ -127,13 +127,13 @@ python_api_name: qiskit.chemistry.FermionicOperator ### h1 - + Getter of one body integral tensor. ### h2 - + Getter of two body integral tensor. @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.FermionicOperator ### modes - + Getter of modes. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.mdx index c2b377d45e7..fc1c0380536 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # qiskit.chemistry.MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_delta - + Get the MP2 delta energy correction for the molecule **Returns** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_energy - + Get the MP2 energy for the molecule **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.mdx index 14a734d0ea7..42d44f3c935 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # qiskit.chemistry.QMolecule - + Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.QMolecule ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.QMolecule ### filename - + returns temp file path @@ -96,13 +96,13 @@ python_api_name: qiskit.chemistry.QMolecule ### one\_body\_integrals - + Returns one body electron integrals. ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -157,13 +157,13 @@ python_api_name: qiskit.chemistry.QMolecule ### two\_body\_integrals - + Returns two body electron integrals. ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -186,7 +186,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -207,23 +207,23 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ### x\_dipole\_integrals - + returns x\_dipole\_integrals ### y\_dipole\_integrals - + returns y\_dipole\_integrals ### z\_dipole\_integrals - + returns z\_dipole\_integrals diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.mdx index 45da8572dcd..ccb0d52f7a2 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.mdx index 57c3baba265..4bb91464db2 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # qiskit.chemistry.WatsonHamiltonian - + Watson Hamiltonian class containing the results of a driver’s anharmonic calculation **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### data - + Returns the matrix elements of the Hamiltonian **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### num\_modes - + Returns the number of modes **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.mdx index 5712c6b1d7e..10d3766d08a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # qiskit.chemistry.algorithms.AdaptVQE - + A ground state calculation employing the AdaptVQE algorithm. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.mdx index c75a433cbe4..b004204cd19 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # qiskit.chemistry.algorithms.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 1686584e54e..8f837c70792 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # qiskit.chemistry.algorithms.EigensolverFactory - + A factory to construct a eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index 8d7068dcde7..c45e4b8bb74 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # qiskit.chemistry.algorithms.ExcitedStatesEigensolver - + The calculation of excited states via an Eigensolver algorithm **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 6f28d97e44f..c9d661eb9a5 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # qiskit.chemistry.algorithms.ExcitedStatesSolver - + The excited states calculation interface ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index 049d02842ec..31a09b74c85 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # qiskit.chemistry.algorithms.GroundStateEigensolver - + Ground state computation using a minimum eigensolver. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.mdx index a002dbd0c3e..e50c38a15a1 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # qiskit.chemistry.algorithms.GroundStateSolver - + The ground state calculation interface **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index b8a0edc1c32..5d10457f982 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # qiskit.chemistry.algorithms.MinimumEigensolverFactory - + A factory to construct a minimum eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index bbd3a1ddb68..5f614a46726 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # qiskit.chemistry.algorithms.NumPyEigensolverFactory - + A factory to construct a NumPyEigensolver. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### k - + returns k (number of eigenvalues requested) **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index a4bf14b44a3..fefb70f9093 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory - + A factory to construct a NumPyMinimumEigensolver. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index e5528c63fe3..e8d5c65a150 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # qiskit.chemistry.algorithms.OrbitalOptimizationVQE - + A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.mdx index 155c7f29498..b19172b381e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # qiskit.chemistry.algorithms.QEOM - + The calculation of excited states via the qEOM algorithm **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM ### excitations - + Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.mdx index c99651d042d..f7ac0463f6b 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # qiskit.chemistry.algorithms.QEomEE - + QEomEE algorithm (classical) **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### random - + Return a numpy random. @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.mdx index e429ecb926b..36ba3a7482f 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # qiskit.chemistry.algorithms.QEomVQE - + QEomVQE algorithm **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### random - + Return a numpy random. @@ -371,13 +371,13 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -393,7 +393,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.mdx index c49597fb26e..84fcedb1479 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # qiskit.chemistry.algorithms.VQEAdapt - + DEPRECATED. The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -166,13 +166,13 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -182,7 +182,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### random - + Return a numpy random. @@ -231,7 +231,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 28a0bb2ea8a..336e3102f39 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # qiskit.chemistry.algorithms.VQEUCCSDFactory - + A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### excitation\_type - + Getter of the `excitation_type` setting for the `excitation_type` setting. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_doubles - + Getter of the `method_doubles` setting for the `method_doubles` setting. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_singles - + Getter of the `method_singles` setting for the `method_singles` setting. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### same\_spin\_doubles - + Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index 56ad20a7469..544678a0c18 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # qiskit.chemistry.algorithms.VQEUVCCSDFactory - + A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 443eed81800..42d93c09387 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # qiskit.chemistry.algorithms.pes\_samplers.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index 65d0d472d1e..8b778a0d359 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # qiskit.chemistry.algorithms.pes\_samplers.DifferentialExtrapolator - + An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. Constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 84212db2c03..76fbb133fae 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # qiskit.chemistry.algorithms.pes\_samplers.EnergySurface1DSpline - + A simple cubic spline interpolation for the potential energy surface. A spline interpolation method for data fitting. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 3e97db2bc4f..d4ffd4621d7 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # qiskit.chemistry.algorithms.pes\_samplers.EnergySurfaceBase - + Class to hold a potential energy surface ### \_\_init\_\_ @@ -30,7 +30,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 84a5c18de02..9165093f82e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # qiskit.chemistry.algorithms.pes\_samplers.Extrapolator - + This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. Each instance of an Extrapolator requires a dictionary where each item consist of a point (key) and a list of variational parameters (value) for that given point. In practice, a Sampler Class can utilize the Extrapolator as a wrapper. The Extrapolator class then extracts optimal variational parameters from the previous points for use in extrapolation. For instance, one can utilize the Extrapolator to accelerate the computation of the Born-Oppenheimer Potential Energy Surface (BOPES) for a given molecule. In this case, each point can represent the interatomic distance and the list of parameters represent rotational parameters in a quantum circuit, in the context of computing the bond dissociation profile for a diatomic molecule. NOTE: However this is not a requirement - once an instance of the Extrapolator class is created, extrapolation can proceed by specifying the point(s) of interest and the dictionary of (point, parameter) pairs for a problem. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index 641fc6c3308..7a703d8b595 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # qiskit.chemistry.algorithms.pes\_samplers.HarmonicPotential - + Implements a 1D Harmonic potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + **Mostly for internal use. Preprocesses the data passed to fit\_to\_data()** so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 6197220d86a..141f6d4b0b6 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # qiskit.chemistry.algorithms.pes\_samplers.MorsePotential - + Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 44468f8e352..67e8ca8a7b3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PCAExtrapolator - + A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. Constructor. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index 337b214f283..3de1b074082 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PolynomialExtrapolator - + An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 953d1ee37a0..0250897ea92 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # qiskit.chemistry.algorithms.pes\_samplers.PotentialBase - + Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index 3c67abc8f76..202958a6a30 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.SieveExtrapolator - + A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. Constructor. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index 002af5ea244..ec3bc4b8640 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # qiskit.chemistry.algorithms.pes\_samplers.VibronicStructureBase - + Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 650f2acfed1..0f7dd5c2eee 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.WindowExtrapolator - + An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. Constructor. @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### extrapolator - + Returns the internal extrapolator. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### window - + Returns the size of the window. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index 34e4da3f0c4..c8581e90b98 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # qiskit.chemistry.applications.MolecularGroundStateEnergy - + Molecular ground state energy chemistry application **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### driver - + Returns chemistry driver **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### solver - + Returns minimum eigen solver **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 89111f7e7a3..1c4e110e046 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # qiskit.chemistry.components.bosonic\_bases.BosonicBasis - + Basis to express a second quantization Bosonic Hamiltonian. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 4f35286f61f..dab39d88a4e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # qiskit.chemistry.components.bosonic\_bases.HarmonicBasis - + Basis in which the Watson Hamiltonian is expressed. This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) as a modal basis for the expression of the Watson Hamiltonian or any bosonic operator. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0a607b86123..a4fc9327b76 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # qiskit.chemistry.components.initial\_states.HartreeFock - + A Hartree-Fock initial state. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.mdx index 3573ece0570..a9ea53953b9 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # qiskit.chemistry.components.initial\_states.VSCF - + Initial state for vibrational modes. Creates an occupation number vector as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. e.g. for 2 modes with 4 modals per mode it creates: |1000 1000> @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.mdx index 721e5653143..96e4629a59c 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # qiskit.chemistry.components.variational\_forms.CHC - + This trial wavefunction is the Compact Heuristic for Chemistry. The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. It aims at approximating the UCC Ansatz for a lower CNOT count. @@ -86,13 +86,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -142,11 +142,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.mdx index 59b6ee0d9ff..fed06dc156b 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # qiskit.chemistry.components.variational\_forms.UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -209,13 +209,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### double\_excitations - + Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] ### excitation\_pool - + Returns the full list of available excitations (called the pool). **Return type** @@ -225,13 +225,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -275,7 +275,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### parameter\_bounds - + Parameter bounds. **Returns** @@ -342,7 +342,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -358,7 +358,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -382,17 +382,17 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### setting - + ### single\_excitations - + Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.mdx index b1374beb072..788145ce31e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # qiskit.chemistry.components.variational\_forms.UVCC - + This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -126,13 +126,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -182,11 +182,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -200,7 +200,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.mdx index e1aeaf92671..0dcfe95e6e0 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,12 +8,12 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # qiskit.chemistry.core.ChemistryOperator - + Base class for ChemistryOperator. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### molecule\_info - + returns molecule info @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.mdx index 8843e492624..00d4ae27ad0 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # qiskit.chemistry.core.Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### molecule\_info - + returns molecule info diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.mdx index 2f3b74c1c13..9960bbe4a4a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # qiskit.chemistry.core.MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 74542543f4b..9fb56ed0560 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # qiskit.chemistry.core.MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 3beb168f157..30c91adb960 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # qiskit.chemistry.core.MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.mdx index e4a1697a231..a9aff48d83a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # qiskit.chemistry.core.QubitMappingType - + QubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.mdx index 262ec05ebbc..58368e87694 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # qiskit.chemistry.core.TransformationType - + Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.mdx index ac19637363a..91e8c384daa 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # qiskit.chemistry.drivers.BaseDriver - + Base class for Qiskit’s chemistry drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### basis - + return basis **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### molecule - + return molecule **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.mdx index df886e5eab1..5d6330f8ca0 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # qiskit.chemistry.drivers.BasisType - + Basis Type ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.mdx index 48b7a932af8..eea5be18efe 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # qiskit.chemistry.drivers.BosonicDriver - + Base class for Qiskit’s chemistry bosonic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 2ac2ff37113..64af52d8b37 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # qiskit.chemistry.drivers.FCIDumpDriver - + Qiskit chemistry driver reading an FCIDump file. The FCIDump format is partially defined in Knowles1989. @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### basis - + return basis **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### molecule - + return molecule **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.mdx index 9698b0ba2e4..41f39e2dcac 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # qiskit.chemistry.drivers.FermionicDriver - + Base class for Qiskit’s chemistry fermionic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.mdx index 9ce181344d5..4b83193d6b3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # qiskit.chemistry.drivers.GaussianDriver - + Qiskit chemistry driver using the Gaussian™ 16 program. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index cd7ea2d7d8f..08d46359fff 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # qiskit.chemistry.drivers.GaussianForcesDriver - + Gaussian™ 16 forces driver. **Parameters** @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 9d606b4ad1b..e36dbee06aa 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # qiskit.chemistry.drivers.GaussianLogDriver - + Gaussian™ 16 log driver. Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.mdx index 4d3c5a5ce94..7ee96b06672 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # qiskit.chemistry.drivers.GaussianLogResult - + Result for Gaussian™ 16 log driver. This result allows access to selected data from the log file that is not available via the use Gaussian 16 interfacing code when using the MatrixElement file. Since this parses the text output it is subject to the format of the log file. @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### a\_to\_h\_numbering - + A to H numbering mapping. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### cubic\_force\_constants - + Cubic force constants. (3 indices, 3 values) **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### log - + The complete Gaussian log in the form of a list of strings. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quadratic\_force\_constants - + Quadratic force constants. (2 indices, 3 values) **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quartic\_force\_constants - + Quartic force constants. (4 indices, 3 values) **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.mdx index 3cefebe757f..948e73faea3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # qiskit.chemistry.drivers.HDF5Driver - + Qiskit chemistry driver reading an HDF5 file. The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### basis - + return basis **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### molecule - + return molecule **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### work\_path - + Returns work path. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.mdx index 36c88a55523..7af31402def 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # qiskit.chemistry.drivers.HFMethodType - + HFMethodType Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.mdx index b3623aea87e..099eda4e94f 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # qiskit.chemistry.drivers.InitialGuess - + Initial Guess Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.mdx index 4736dcd3c34..adde40ac520 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # qiskit.chemistry.drivers.Molecule - + Driver-independent Molecule definition. This module implements an interface for a driver-independent, i.e. generic molecule definition. It defines the composing atoms (with properties like masses), and allows for changing the molecular geometry through given degrees of freedom (e.g. bond-stretching, angle-bending, etc.). The geometry as provided in the constructor can be affected, through setting perturbations, and it is this perturbed geometry that is supplied by the geometry getter. Setting perturbations to None will cause the original geometry to be returned, and there is a getter to get this value directly if its needed. @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### charge - + Get charge **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### geometry - + Get geometry accounting for any perturbations **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### masses - + Get masses **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### multiplicity - + Get multiplicity **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### perturbations - + Get perturbations **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -206,7 +206,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) @@ -224,7 +224,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### units - + The geometry coordinate units diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.mdx index 3fb20d1d394..bd018fbd6f3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # qiskit.chemistry.drivers.PSI4Driver - + Qiskit chemistry driver using the PSI4 program. See [http://www.psicode.org/](http://www.psicode.org/) @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.mdx index b2106147207..423d3eabda9 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # qiskit.chemistry.drivers.PyQuanteDriver - + Qiskit chemistry driver using the PyQuante2 library. See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante2) @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### basis - + return basis **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### molecule - + return molecule **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.mdx index 29b4d848a11..24879916fd1 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # qiskit.chemistry.drivers.PySCFDriver - + Qiskit chemistry driver using the PySCF library. See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### basis - + return basis **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### molecule - + return molecule **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.mdx index f9fa0412ddf..83a3a911c16 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # qiskit.chemistry.drivers.UnitsType - + Units Type Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.mdx index 36205b5512a..a786749378f 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # qiskit.chemistry.results.BOPESSamplerResult - + The BOPES Sampler result Creates an new instance of the result. :type points: `List`\[`float`] :param points: List of points. :type energies: `List`\[`float`] :param energies: List of energies. :type raw\_results: `Dict`\[`float`, `EigenstateResult`] :param raw\_results: Raw results obtained from the solver. @@ -36,7 +36,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### energies - + returns list of energies. **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### points - + returns list of points. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### raw\_results - + returns all results for all points. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.mdx index 954cc118e43..12f2c70edb4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # qiskit.chemistry.results.EigenstateResult - + The eigenstate result interface. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenenergies - + returns eigen energies **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenstates - + returns eigen states **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundenergy - + returns ground energy **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundstate - + returns ground state **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.mdx index da8d5298511..c3e8534fcb4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # qiskit.chemistry.results.ElectronicStructureResult - + The electronic structure result. ### \_\_init\_\_ @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_energies - + Returns electronic part of ground state energy **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundstate - + returns ground state **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### magnetization - + Returns measured magnetization **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### num\_particles - + Returns measured number of particles **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -376,7 +376,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### spin - + Returns computed spin **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -396,7 +396,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** @@ -416,7 +416,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_energies - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.mdx index a887eb829fe..c41c7b869cf 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # qiskit.chemistry.results.VibronicStructureResult - + The vibronic structure result. ### \_\_init\_\_ @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### computed\_vibronic\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundstate - + returns ground state **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### num\_occupied\_modals\_per\_mode - + Returns the number of occupied modal per mode **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 92a08ff1be8..f43a2851888 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # qiskit.chemistry.transformations.BosonicQubitMappingType - + BosonicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.mdx index 10ae059df90..2106cb09a1a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # qiskit.chemistry.transformations.BosonicTransformation - + A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### basis - + returns the basis (number of modals per mode) **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### num\_modes - + the number of modes **Type** @@ -147,7 +147,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.mdx index 3fcffefe2ae..c30b6fb37ef 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # qiskit.chemistry.transformations.BosonicTransformationType - + BosonicTransformationType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index fd03b5106aa..ffde0817035 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # qiskit.chemistry.transformations.FermionicQubitMappingType - + FermionicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.mdx index b1c59782d78..d35778e2310 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # qiskit.chemistry.transformations.FermionicTransformation - + A transformation from a fermionic problem, represented by a driver, to a qubit operator. **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### molecule\_info - + Getter of the molecule information. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### qubit\_mapping - + Getter of the qubit mapping. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.mdx index ccd64026ceb..440aa1e271c 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # qiskit.chemistry.transformations.FermionicTransformationType - + Electronic Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.mdx index 169b0076a07..dae4e6f83d6 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # qiskit.chemistry.transformations.Transformation - + Base class for transformation to qubit operators for chemistry problems ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.mdx index 0b0ae623073..b3281422238 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # qiskit.circuit.AncillaQubit - + A qubit used as ancillary qubit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.AncillaQubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.mdx index c6971c51192..eb116e3822d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # qiskit.circuit.AncillaRegister - + Implement an ancilla register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.mdx index 0f0b3c1169f..6e040f63c60 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # qiskit.circuit.ClassicalRegister - + Implement a classical register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Clbit.mdx index b4c5ce884ae..c9d9a550d63 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # qiskit.circuit.Clbit - + Implement a classical bit. Creates a classical bit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Clbit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.mdx index f67a23e0354..7091f6ed192 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # qiskit.circuit.ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -324,13 +324,13 @@ python_api_name: qiskit.circuit.ControlledGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.ControlledGate ### duration - + Get the duration. @@ -362,7 +362,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return gate label **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.circuit.ControlledGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.ControlledGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.ControlledGate ### params - + Get parameters from base\_gate. **Returns** @@ -540,7 +540,7 @@ python_api_name: qiskit.circuit.ControlledGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Delay.mdx index 7f711f95e1b..3143ff8d521 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # qiskit.circuit.Delay - + Do nothing and just delay/wait/idle for a specified duration. Create new delay instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Delay ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration of this delay. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.Delay ### params - + return instruction params. @@ -240,7 +240,7 @@ python_api_name: qiskit.circuit.Delay ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.mdx index 00f71e10fbe..132c39310f7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # qiskit.circuit.EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Gate.mdx index 67be8b2a688..3464948ed55 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # qiskit.circuit.Gate - + Unitary gate. Create a new gate. @@ -187,19 +187,19 @@ python_api_name: qiskit.circuit.Gate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return gate label **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.circuit.Gate ### params - + return instruction params. @@ -371,7 +371,7 @@ python_api_name: qiskit.circuit.Gate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Instruction.mdx index 4014dc71d70..53b83c3b99c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # qiskit.circuit.Instruction - + Generic quantum instruction. Create a new instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.circuit.Instruction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.Instruction ### params - + return instruction params. @@ -267,7 +267,7 @@ python_api_name: qiskit.circuit.Instruction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.mdx index 3cd05f0003e..b3ad228266e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # qiskit.circuit.InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Measure.mdx index e4ebf16f584..3f5840d2486 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # qiskit.circuit.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Parameter.mdx index 806e44c059a..9b1c2d7d91e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # qiskit.circuit.Parameter - + Parameter Class for variable parameters. Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). @@ -166,13 +166,13 @@ python_api_name: qiskit.circuit.Parameter ### name - + Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.mdx index 0c123d87771..7535c0371b9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # qiskit.circuit.ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). @@ -171,7 +171,7 @@ python_api_name: qiskit.circuit.ParameterExpression ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.mdx index 1f89d746816..8c9ee0b0bbb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # qiskit.circuit.ParameterVector - + ParameterVector class to quickly generate lists of parameters. ### \_\_init\_\_ @@ -40,13 +40,13 @@ python_api_name: qiskit.circuit.ParameterVector ### name - + Returns the name of the ParameterVector. ### params - + Returns the list of parameters in the ParameterVector. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.mdx index c98f0a12690..1b1e977697a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # qiskit.circuit.QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -323,7 +323,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -482,7 +482,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -492,7 +492,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -528,19 +528,19 @@ python_api_name: qiskit.circuit.QuantumCircuit ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -758,7 +758,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### data - + Return the circuit data (instructions and context). **Returns** @@ -971,7 +971,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -989,7 +989,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1007,7 +1007,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### global\_phase - + Return the global phase of the circuit in radians. @@ -1420,7 +1420,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1434,13 +1434,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1472,13 +1472,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1506,7 +1506,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1653,7 +1653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.mdx index 06b8f372671..427b50414e5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # qiskit.circuit.QuantumRegister - + Implement a quantum register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Qubit.mdx index 8f18a4b8a5b..9c1d1c5eb6a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # qiskit.circuit.Qubit - + Implement a quantum bit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Qubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.26/qiskit.circuit.Reset.mdx index dab23df6ede..d5e4389b4ac 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # qiskit.circuit.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 6d7b7af0269..844b59e8d23 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # qiskit.circuit.classicalfunction.BooleanExpression - + The Boolean Expression gate. **Parameters** @@ -190,25 +190,25 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### label - + Return gate label **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### params - + return instruction params. @@ -432,7 +432,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 7b3676d0dae..1546e2d239e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # qiskit.circuit.classicalfunction.ClassicalFunction - + Represent a classical function function and its logic network. Creates a `ClassicalFunction` from Python source code in `source`. @@ -94,7 +94,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### args - + Returns the classicalfunction arguments @@ -219,19 +219,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### label - + Return gate label **Return type** @@ -291,13 +291,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### network - + Returns the logical network ### params - + return instruction params. @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### qregs - + The list of qregs used by the classicalfunction @@ -379,7 +379,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### scopes - + Returns the scope dict @@ -476,13 +476,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### truth\_table - + Returns (and computes) the truth table ### types - + Dumps a list of scopes with their variables and types. **Returns** @@ -496,7 +496,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4e8d89a0540..06ac2b44dce 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 440d4532159..b13f84a2a7f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.AND.mdx index c60fef512c2..d2674693e6b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # qiskit.circuit.library.AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.AND ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.AND ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.AND ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.AND ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.AND ### global\_phase - + Return the global phase of the circuit in radians. @@ -1335,7 +1335,7 @@ python_api_name: qiskit.circuit.library.AND ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1349,13 +1349,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1387,13 +1387,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1421,7 +1421,7 @@ python_api_name: qiskit.circuit.library.AND ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1568,7 +1568,7 @@ python_api_name: qiskit.circuit.library.AND ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.mdx index f04f40eeaca..ae107288303 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # qiskit.circuit.library.Barrier - + Barrier instruction. Create new barrier instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Barrier ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.library.Barrier ### params - + return instruction params. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.Barrier ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.mdx index 9fcd4dc4048..df0585a6fe5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # qiskit.circuit.library.C3SXGate - + The 3-qubit controlled sqrt-X gate. This implementation is based on Page 17 of \[1]. @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -204,13 +204,13 @@ python_api_name: qiskit.circuit.library.C3SXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### params - + Get parameters from base\_gate. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.mdx index b71a6f73b86..e232348a667 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # qiskit.circuit.library.C3XGate - + The 4-qubit controlled X gate. This implementation uses $\sqrt{T}$ and 14 CNOT gates. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.C3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### duration - + Get the duration. @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return gate label **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### params - + Get parameters from base\_gate. **Returns** @@ -396,7 +396,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.mdx index f214afe8823..5c5cfda9906 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # qiskit.circuit.library.C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1], with the use of the relative phase version of c3x, the rc3x \[2]. @@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -188,13 +188,13 @@ python_api_name: qiskit.circuit.library.C4XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### params - + Get parameters from base\_gate. **Returns** @@ -400,7 +400,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.mdx index 658a6a6b86a..199f906c493 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # qiskit.circuit.library.CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** @@ -228,7 +228,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -238,13 +238,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -254,7 +254,7 @@ $$ ### duration - + Get the duration. @@ -272,7 +272,7 @@ $$ ### label - + Return gate label **Return type** @@ -298,7 +298,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -312,7 +312,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -326,7 +326,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -450,7 +450,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.mdx index 3d83e02c772..862287fd647 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # qiskit.circuit.library.CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. @@ -223,7 +223,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -233,13 +233,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -249,7 +249,7 @@ $$ ### duration - + Get the duration. @@ -267,7 +267,7 @@ $$ ### label - + Return gate label **Return type** @@ -293,7 +293,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -307,7 +307,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -321,7 +321,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -445,7 +445,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.mdx index 287c7b6c362..a874a477ab4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # qiskit.circuit.library.CPhaseGate - + Controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.mdx index 6dd6abd6b7b..8d5e3a9223c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # qiskit.circuit.library.CRXGate - + Controlled-RX gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.mdx index 85560f7ec9b..33b08027b5d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # qiskit.circuit.library.CRYGate - + Controlled-RY gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.mdx index 820c2d7c629..f0212271a13 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # qiskit.circuit.library.CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -226,7 +226,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -236,13 +236,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -252,7 +252,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.mdx index 7b80f2d7f0b..a208b522311 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # qiskit.circuit.library.CSXGate - + Controlled-√X gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -268,7 +268,7 @@ $$ ### label - + Return gate label **Return type** @@ -294,7 +294,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -308,7 +308,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -322,7 +322,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -446,7 +446,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.mdx index d46ee153681..98c5fee02e2 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # qiskit.circuit.library.CSwapGate - + Controlled-X gate. **Circuit symbol:** @@ -239,7 +239,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -249,13 +249,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -265,7 +265,7 @@ $$ ### duration - + Get the duration. @@ -283,7 +283,7 @@ $$ ### label - + Return gate label **Return type** @@ -309,7 +309,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -323,7 +323,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -337,7 +337,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -461,7 +461,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.mdx index f27051341f6..569fe5db52e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # qiskit.circuit.library.CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.mdx index 33793c4aa91..4d8756ed06d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # qiskit.circuit.library.CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.mdx index 34768816364..f7f98793b8f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # qiskit.circuit.library.CUGate - + Controlled-U gate (4-parameter two-qubit gate). This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $e^{i\gamma}$ of the U gate. @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.mdx index 1da615ebb22..70cb1ed00f3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # qiskit.circuit.library.CXGate - + Controlled-X gate. **Circuit symbol:** @@ -222,7 +222,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -232,13 +232,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -248,7 +248,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return gate label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.mdx index 8ea7e3f1d76..64b9235ed47 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # qiskit.circuit.library.CYGate - + Controlled-Y gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.mdx index 8d0a179fd86..927190ee3f8 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # qiskit.circuit.library.CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. @@ -201,7 +201,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -211,13 +211,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -227,7 +227,7 @@ $$ ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -285,7 +285,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -299,7 +299,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.mdx index 116bae511b8..bdd4156ad90 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # qiskit.circuit.library.DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. @@ -195,19 +195,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.mdx index 6f6995d3157..06c2d987e84 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # qiskit.circuit.library.Diagonal - + Diagonal circuit. Circuit symbol: @@ -272,7 +272,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -431,7 +431,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -441,7 +441,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -477,19 +477,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -707,7 +707,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1369,7 +1369,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1383,13 +1383,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1421,13 +1421,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1455,7 +1455,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1602,7 +1602,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.mdx index 774d6497e43..b214acf5abf 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # qiskit.circuit.library.ECRGate - + An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). This gate is maximally entangling and is equivalent to a CNOT up to single-qubit pre-rotations. The echoing procedure mitigates some unwanted terms (terms other than ZX) to cancel in an experiment. @@ -219,19 +219,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ $$ ### label - + Return gate label **Return type** @@ -291,7 +291,7 @@ $$ ### params - + return instruction params. @@ -391,7 +391,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.mdx index 7b3ce361ca1..f0dbd24102b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # qiskit.circuit.library.EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + Return the circuit data (instructions and context). **Returns** @@ -872,7 +872,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### global\_phase - + Return the global phase of the circuit in radians. @@ -1040,7 +1040,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1170,7 +1170,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1433,7 +1433,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1447,13 +1447,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1509,7 +1509,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1529,7 +1529,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1559,7 +1559,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1609,7 +1609,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1720,7 +1720,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qregs - + A list of the quantum registers associated with the circuit. @@ -1794,7 +1794,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1856,7 +1856,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1962,7 +1962,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.mdx index 3ff112752bb..270a1da7788 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # qiskit.circuit.library.ExcitationPreserving - + The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -355,7 +355,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -909,7 +909,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -955,7 +955,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1015,7 +1015,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1063,7 +1063,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1193,7 +1193,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1456,7 +1456,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1470,13 +1470,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1500,7 +1500,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1522,7 +1522,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1532,7 +1532,7 @@ $$ ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1552,7 +1552,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1582,7 +1582,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1618,7 +1618,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1632,7 +1632,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1673,7 +1673,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1743,7 +1743,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1817,7 +1817,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1879,7 +1879,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1985,7 +1985,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.mdx index 7fd5c89d49c..70e63a2cb9b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # qiskit.circuit.library.FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.FourierChecking ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### data - + Return the circuit data (instructions and context). **Returns** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -940,7 +940,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### global\_phase - + Return the global phase of the circuit in radians. @@ -1353,7 +1353,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1367,13 +1367,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1405,13 +1405,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1439,7 +1439,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.mdx index 5f2eb519d15..6b5afd24029 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # qiskit.circuit.library.FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -369,7 +369,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,7 +1363,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1377,13 +1377,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1425,13 +1425,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1467,7 +1467,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1550,7 +1550,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qregs - + A list of the quantum registers associated with the circuit. @@ -1624,7 +1624,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.mdx index f7095cd33dd..b52f49224da 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # qiskit.circuit.library.GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -259,7 +259,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -418,7 +418,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -428,7 +428,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -464,19 +464,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -943,7 +943,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1356,7 +1356,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1370,13 +1370,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1408,13 +1408,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1442,7 +1442,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1589,7 +1589,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GR.mdx index a787fb4b8d0..a467ab25c4b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # qiskit.circuit.library.GR - + Global R gate. **Circuit symbol:** @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.mdx index 7de225afe8c..cc48f715b80 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # qiskit.circuit.library.GRX - + Global RX gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.mdx index 3dbfa71dcf2..dd533f8b939 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # qiskit.circuit.library.GRY - + Global RY gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.mdx index 3cacaea5d20..deec056791a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # qiskit.circuit.library.GRZ - + Global RZ gate. **Circuit symbol:** @@ -252,7 +252,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.mdx index eeeae1fbf93..581314e439d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # qiskit.circuit.library.GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -262,7 +262,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -421,7 +421,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -431,7 +431,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -467,19 +467,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -697,7 +697,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -910,7 +910,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -928,7 +928,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1359,7 +1359,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1373,13 +1373,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1411,13 +1411,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1445,7 +1445,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1592,7 +1592,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.mdx index ba753fd32e6..2cfd242e92a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # qiskit.circuit.library.GroverOperator - + The Grover operator. Grover’s search algorithm \[1, 2] consists of repeated applications of the so-called Grover operator used to amplify the amplitudes of the desired output states. This operator, $\mathcal{Q}$, consists of the phase oracle, $\mathcal{S}_f$, zero phase-shift or zero reflection, $\mathcal{S}_0$, and an input state preparation $\mathcal{A}$: @@ -369,7 +369,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -528,7 +528,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -538,7 +538,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -574,19 +574,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -804,7 +804,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1017,7 +1017,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1035,7 +1035,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1053,7 +1053,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1466,7 +1466,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1480,13 +1480,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1518,13 +1518,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1546,7 +1546,7 @@ $$ ### oracle - + The oracle implementing a reflection about the bad state. @@ -1558,7 +1558,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1705,7 +1705,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1729,7 +1729,7 @@ $$ ### reflection\_qubits - + Reflection qubits, on which S0 is applied (if S0 is not user-specified). @@ -2601,7 +2601,7 @@ $$ ### state\_preparation - + The subcircuit implementing the A operator or Hadamards. **Return type** @@ -2902,7 +2902,7 @@ $$ ### zero\_reflection - + The subcircuit implementing the reflection about 0. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.mdx index 51a7c2399ba..f281bf88e40 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # qiskit.circuit.library.HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -221,7 +221,7 @@ $$ ### label - + Return gate label **Return type** @@ -247,7 +247,7 @@ $$ ### params - + return instruction params. @@ -359,7 +359,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.mdx index 74f3b7a7518..fa54d175a2d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # qiskit.circuit.library.HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.mdx index 00642ce66cc..9ee7a4ee743 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # qiskit.circuit.library.IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.mdx index e8dc28c98b0..9ac3a2ab723 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # qiskit.circuit.library.IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.IQP ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.IQP ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.IQP ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.IQP ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.IQP ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.IQP ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.IQP ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.IQP ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.mdx index 2eedea576da..9ea34e76aab 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # qiskit.circuit.library.InnerProduct - + An n\_qubit circuit that computes the inner product of two registers. Return a circuit to compute the inner product of 2 n-qubit registers. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -395,7 +395,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -405,7 +405,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -441,19 +441,19 @@ python_api_name: qiskit.circuit.library.InnerProduct ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -671,7 +671,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### data - + Return the circuit data (instructions and context). **Returns** @@ -884,7 +884,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -902,7 +902,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,7 +1333,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1347,13 +1347,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1385,13 +1385,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1419,7 +1419,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1566,7 +1566,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.mdx index 5660ecc1c15..54d64d34f8d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # qiskit.circuit.library.IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on the parameter `geq`): @@ -247,7 +247,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -406,7 +406,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -416,7 +416,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -452,19 +452,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -682,7 +682,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -913,7 +913,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -931,7 +931,7 @@ $$ ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -945,7 +945,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1358,7 +1358,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1372,19 +1372,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1416,7 +1416,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1426,13 +1426,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -1468,7 +1468,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1551,7 +1551,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1625,7 +1625,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2774,7 +2774,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 392f5562a73..971bd51c69b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # qiskit.circuit.library.LinearAmplitudeFunction - + A circuit implementing a (piecewise) linear function on qubit amplitudes. An amplitude function $F$ of a function $f$ is a mapping @@ -282,7 +282,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -441,7 +441,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -451,7 +451,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -487,19 +487,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -717,7 +717,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1379,7 +1379,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1393,13 +1393,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,13 +1431,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1465,7 +1465,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1630,7 +1630,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.mdx index 7feb3e22f48..1f3e8d18a1e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # qiskit.circuit.library.LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -927,7 +927,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -945,7 +945,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -963,7 +963,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,7 +1390,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1404,13 +1404,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1442,7 +1442,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1452,13 +1452,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1488,7 +1488,7 @@ $$ ### offset - + The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. @@ -1510,7 +1510,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1593,7 +1593,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1667,7 +1667,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2366,7 +2366,7 @@ $$ ### slope - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.mdx index aef4f1605de..8a5d5d96845 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # qiskit.circuit.library.LogNormalDistribution - + A circuit to encode a discretized log-normal distribution in qubit amplitudes. A random variable $X$ is log-normal distributed if @@ -281,7 +281,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -440,7 +440,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -450,7 +450,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -460,7 +460,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -496,19 +496,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -726,7 +726,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -939,7 +939,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1388,7 +1388,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1402,13 +1402,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1440,13 +1440,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1474,7 +1474,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1511,7 +1511,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1631,7 +1631,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2780,7 +2780,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.mdx index b912db55f6b..1ea3e6caf63 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # qiskit.circuit.library.MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as: @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.MCMT ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.MCMT ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -467,19 +467,19 @@ python_api_name: qiskit.circuit.library.MCMT ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -679,7 +679,7 @@ python_api_name: qiskit.circuit.library.MCMT ### data - + Return the circuit data (instructions and context). **Returns** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -910,7 +910,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -928,7 +928,7 @@ python_api_name: qiskit.circuit.library.MCMT ### global\_phase - + Return the global phase of the circuit in radians. @@ -1301,7 +1301,7 @@ python_api_name: qiskit.circuit.library.MCMT ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1315,19 +1315,19 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_ancilla\_qubits - + Return the number of ancillas. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1393,7 +1393,7 @@ python_api_name: qiskit.circuit.library.MCMT ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1540,7 +1540,7 @@ python_api_name: qiskit.circuit.library.MCMT ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.mdx index d38a25c1f79..7d6ec1ec718 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # qiskit.circuit.library.MCMTVChain - + The MCMT implementation using the CCX V-chain. This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -443,7 +443,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -453,7 +453,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -489,19 +489,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### data - + Return the circuit data (instructions and context). **Returns** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### global\_phase - + Return the global phase of the circuit in radians. @@ -1323,7 +1323,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1337,19 +1337,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_ancilla\_qubits - + Return the number of ancilla qubits required. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1381,13 +1381,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1562,7 +1562,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.mdx index 8ff6f6a2f0c..95094eee33f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # qiskit.circuit.library.MCPhaseGate - + Multi-controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the state of the control qubits. @@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -201,13 +201,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### duration - + Get the duration. @@ -235,7 +235,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### label - + Return gate label **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### params - + Get parameters from base\_gate. **Returns** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.mdx index 5f63d0f905d..197ad249388 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # qiskit.circuit.library.MCXGate - + The general, multi-controlled X gate. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.mdx index b59f372d7e8..71e449a2e93 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # qiskit.circuit.library.MCXGrayCode - + Implement the multi-controlled X gate using the Gray code. This delegates the implementation to the MCU1 gate, since $X = H \cdot U1(\pi) \cdot H$. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -228,7 +228,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### label - + Return gate label **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -268,13 +268,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### params - + Get parameters from base\_gate. **Returns** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.mdx index dc5130be5b3..81dd6bb49a5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # qiskit.circuit.library.MCXRecursive - + Implement the multi-controlled X gate using recursion. Using a single ancilla qubit, the multi-controlled X gate is recursively split onto four sub-registers. This is done until we reach the 3- or 4-controlled X gate since for these we have a concrete implementation that do not require ancillas. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.mdx index 3df8b84511b..1c8afedd6c5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # qiskit.circuit.library.MCXVChain - + Implement the multi-controlled X gate using a V-chain of CX gates. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### label - + Return gate label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -264,13 +264,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### params - + Get parameters from base\_gate. **Returns** @@ -408,7 +408,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.mdx index 5729c3ab6e5..240441ef2ea 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # qiskit.circuit.library.MSGate - + MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. Global Mølmer–Sørensen gate. @@ -179,19 +179,19 @@ python_api_name: qiskit.circuit.library.MSGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return gate label **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.circuit.library.MSGate ### params - + return instruction params. @@ -363,7 +363,7 @@ python_api_name: qiskit.circuit.library.MSGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.mdx index 9d3017dbe0b..afb38644b4e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # qiskit.circuit.library.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.mdx index 4e83c486ffc..346f1e34b9a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # qiskit.circuit.library.NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -334,7 +334,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.NLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ python_api_name: qiskit.circuit.library.NLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -874,7 +874,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.library.NLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1062,7 +1062,7 @@ python_api_name: qiskit.circuit.library.NLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1192,7 +1192,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1455,7 +1455,7 @@ python_api_name: qiskit.circuit.library.NLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1469,13 +1469,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1551,7 +1551,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1581,7 +1581,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1617,7 +1617,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1672,7 +1672,7 @@ python_api_name: qiskit.circuit.library.NLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1742,7 +1742,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1816,7 +1816,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1878,7 +1878,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1984,7 +1984,7 @@ python_api_name: qiskit.circuit.library.NLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.mdx index edbe32cdaf7..1f1e21ac9c1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # qiskit.circuit.library.NormalDistribution - + A circuit to encode a discretized normal distribution in qubit amplitudes. The probability density function of the normal distribution is defined as @@ -329,7 +329,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -488,7 +488,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -498,7 +498,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -508,7 +508,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -544,19 +544,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -774,7 +774,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -987,7 +987,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1005,7 +1005,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1023,7 +1023,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1436,7 +1436,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1450,13 +1450,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1488,13 +1488,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1522,7 +1522,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1559,7 +1559,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1679,7 +1679,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2828,7 +2828,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.OR.mdx index 305ce9b713f..dbfa8443b74 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # qiskit.circuit.library.OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.OR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.OR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.OR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.OR ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.OR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1335,7 +1335,7 @@ python_api_name: qiskit.circuit.library.OR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1349,13 +1349,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1387,13 +1387,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1421,7 +1421,7 @@ python_api_name: qiskit.circuit.library.OR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1568,7 +1568,7 @@ python_api_name: qiskit.circuit.library.OR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.mdx index 32cd226688b..cf99cabb9bd 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # qiskit.circuit.library.PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -364,7 +364,7 @@ $$ ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -378,7 +378,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -461,7 +461,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -471,7 +471,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -507,19 +507,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -918,7 +918,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -932,7 +932,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -968,7 +968,7 @@ $$ ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -988,7 +988,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1006,7 +1006,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1068,7 +1068,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1116,7 +1116,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1246,7 +1246,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1509,7 +1509,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1523,13 +1523,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1553,7 +1553,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1575,7 +1575,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1585,13 +1585,13 @@ $$ ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1621,7 +1621,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1657,7 +1657,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1671,7 +1671,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1738,7 +1738,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1808,7 +1808,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1882,7 +1882,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1944,7 +1944,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2050,7 +2050,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.mdx index 22690093e59..b4fc6340548 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # qiskit.circuit.library.PauliTwoDesign - + The Pauli Two-Design ansatz. This class implements a particular form of a 2-design circuit \[1], which is frequently studied in quantum machine learning literature, such as e.g. the investigating of Barren plateaus in variational algorithms \[2]. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### data - + Return the circuit data (instructions and context). **Returns** @@ -854,7 +854,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement - + Get the entanglement strategy. **Return type** @@ -868,7 +868,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### global\_phase - + Return the global phase of the circuit in radians. @@ -1022,7 +1022,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1152,7 +1152,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1429,13 +1429,13 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1459,7 +1459,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1491,7 +1491,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters\_settable - + Return the number of settable parameters. **Return type** @@ -1505,7 +1505,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1535,7 +1535,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1571,7 +1571,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1626,7 +1626,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1696,7 +1696,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qregs - + A list of the quantum registers associated with the circuit. @@ -1770,7 +1770,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1832,7 +1832,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1938,7 +1938,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.mdx index a99c069a200..c86ae2fe42d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # qiskit.circuit.library.Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.Permutation ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.Permutation ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.Permutation ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.Permutation ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.Permutation ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.Permutation ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.Permutation ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.Permutation ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.mdx index c846ac36b83..f2bb3e6e6cc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # qiskit.circuit.library.PhaseEstimation - + Phase Estimation circuit. In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.mdx index 70612ae3d38..60776a8b265 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # qiskit.circuit.library.PhaseGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -213,19 +213,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### params - + return instruction params. @@ -381,7 +381,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.mdx index dbb4f0886fb..1adcf6add0f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # qiskit.circuit.library.PhaseOracle - + Phase Oracle. The Phase Oracle object constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR). as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) & (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -972,7 +972,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### global\_phase - + Return the global phase of the circuit in radians. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1399,13 +1399,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1437,13 +1437,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1471,7 +1471,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1618,7 +1618,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.mdx index 0d89982cc28..c312542f99d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # qiskit.circuit.library.PiecewiseChebyshev - + Piecewise Chebyshev approximation to an input function. For a given function $f(x)$ and degree $d$, this class implements a piecewise polynomial Chebyshev approximation on $n$ qubits to $f(x)$ on the given intervals. All the polynomials in the approximation are of degree $d$. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### breakpoints - + The breakpoints for the piecewise approximation. **Return type** @@ -438,7 +438,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### data - + Return the circuit data (instructions and context). **Returns** @@ -750,7 +750,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### degree - + The degree of the polynomials. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### f\_x - + The function to be approximated. **Return type** @@ -955,7 +955,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -991,7 +991,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### global\_phase - + Return the global phase of the circuit in radians. @@ -1404,7 +1404,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1418,13 +1418,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1456,7 +1456,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1466,13 +1466,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1508,7 +1508,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1524,7 +1524,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### polynomials - + The polynomials for the piecewise approximation. **Return type** @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qregs - + A list of the quantum registers associated with the circuit. @@ -1679,7 +1679,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index ef26bc9364c..3033ff60e38 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # qiskit.circuit.library.PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -260,7 +260,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -393,7 +393,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -435,7 +435,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -447,7 +447,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -457,7 +457,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -493,19 +493,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -595,7 +595,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -968,7 +968,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -986,7 +986,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1004,7 +1004,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1272,7 +1272,7 @@ $$ ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -1286,7 +1286,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -1445,7 +1445,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1459,19 +1459,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1503,7 +1503,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1513,13 +1513,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1549,7 +1549,7 @@ $$ ### offsets - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -1567,7 +1567,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1724,7 +1724,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2423,7 +2423,7 @@ $$ ### slopes - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 2f58d18ab72..acb5b8c38f8 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # qiskit.circuit.library.PiecewisePolynomialPauliRotations - + Piecewise-polynomially-controlled Pauli rotations. This class implements a piecewise polynomial (not necessarily continuous) function, $f(x)$, on qubit amplitudes, which is defined through breakpoints and coefficients as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding coefficients by $[a_{j,1},...,a_{j,d}]$, where $d$ is the highest degree among all polynomials. @@ -303,7 +303,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -436,7 +436,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -478,7 +478,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise polynomial function. The function is polynomial in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -494,7 +494,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -504,7 +504,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -540,19 +540,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -564,7 +564,7 @@ $$ ### coeffs - + The coefficients of the polynomials. **Return type** @@ -656,7 +656,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -798,7 +798,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1029,7 +1029,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1047,7 +1047,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1065,7 +1065,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,7 +1333,7 @@ $$ ### mapped\_coeffs - + The coefficients mapped to the internal representation, since we only compare x>=breakpoint. **Return type** @@ -1492,7 +1492,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1506,7 +1506,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1520,13 +1520,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1558,7 +1558,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1568,13 +1568,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1610,7 +1610,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1693,7 +1693,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1767,7 +1767,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.mdx index 144b9b3b39d..c0d429e39c1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # qiskit.circuit.library.PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -508,7 +508,7 @@ $$ ### coeffs - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. @@ -730,7 +730,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -766,7 +766,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -993,7 +993,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1406,7 +1406,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1420,19 +1420,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1464,7 +1464,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1474,13 +1474,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1516,7 +1516,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1599,7 +1599,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1673,7 +1673,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1741,7 +1741,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.mdx index 9a759846d42..82858d3ec3f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # qiskit.circuit.library.QAOAAnsatz - + A generalized QAOA quantum circuit with a support of custom initial states and mixers. **References** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -403,7 +403,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -449,19 +449,19 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -593,7 +593,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cost\_operator - + Returns an operator representing the cost of the optimization problem. **Returns** @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### data - + Return the circuit data (instructions and context). **Returns** @@ -906,7 +906,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -924,7 +924,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### global\_phase - + Return the global phase of the circuit in radians. @@ -990,7 +990,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### initial\_state - + Returns an optional initial state as a circuit **Return type** @@ -1365,7 +1365,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1373,7 +1373,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### mixer\_operator - + Returns an optional mixer operator expressed as an operator or a quantum circuit. **Returns** @@ -1393,13 +1393,13 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1441,7 +1441,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_qubits - + Return number of qubits. @@ -1469,7 +1469,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameter\_bounds - + Parameter bounds. **Returns: A list of pairs indicating the bounds, as (lower, upper). None indicates** @@ -1483,7 +1483,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1570,7 +1570,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qregs - + A list of the quantum registers associated with the circuit. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### reps - + Returns the reps parameter, which determines the depth of the circuit. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.mdx index f359e21d6de..f511bcf090f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # qiskit.circuit.library.QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -259,7 +259,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -290,7 +290,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -432,7 +432,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -442,7 +442,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -478,19 +478,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -708,7 +708,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -811,7 +811,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -953,7 +953,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -971,7 +971,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1135,7 +1135,7 @@ $$ ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -1380,7 +1380,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1394,13 +1394,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1432,7 +1432,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1442,7 +1442,7 @@ $$ ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -1482,7 +1482,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1565,7 +1565,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1639,7 +1639,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.mdx index 0cdd911e5c1..9f084a946d4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # qiskit.circuit.library.QuadraticForm - + Implements a quadratic form on binary variables encoded in qubit registers. A quadratic form on binary variables is a quadratic function $Q$ acting on a binary variable of $n$ bits, $x = x_0 ... x_{n-1}$. For an integer matrix $A$, an integer vector $b$ and an integer $c$ the function can be written as @@ -269,7 +269,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -428,7 +428,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -438,7 +438,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -474,19 +474,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -704,7 +704,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -917,7 +917,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -953,7 +953,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1366,7 +1366,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1380,13 +1380,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1418,13 +1418,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1452,7 +1452,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1599,7 +1599,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1661,7 +1661,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.mdx index 2f7652328db..1076911edc7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # qiskit.circuit.library.QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -453,19 +453,19 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -683,7 +683,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### data - + Return the circuit data (instructions and context). **Returns** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### global\_phase - + Return the global phase of the circuit in radians. @@ -1345,7 +1345,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1397,13 +1397,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.mdx index ee957425994..a1e1aa5d622 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # qiskit.circuit.library.RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RC3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.mdx index fdcaf70dc5e..d08b8ae8071 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # qiskit.circuit.library.RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RCCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.mdx index 95fa41f9b46..2e95ae4fee8 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # qiskit.circuit.library.RGate - + Rotation θ around the cos(φ)x + sin(φ)y axis. **Circuit symbol:** @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ $$ ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ $$ ### params - + return instruction params. @@ -361,7 +361,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.mdx index 4753fbf526a..724a8c3c5ab 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # qiskit.circuit.library.RVGate - + Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. **Circuit symbol:** @@ -207,19 +207,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -363,7 +363,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.mdx index 30836f4c33b..0adeaeab97d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # qiskit.circuit.library.RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.mdx index 05daf903c31..bb620977c24 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # qiskit.circuit.library.RXXGate - + A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.mdx index 3f32c8fabd2..a384f4039a6 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # qiskit.circuit.library.RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.mdx index d0ec9e70219..eb937897cb2 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # qiskit.circuit.library.RYYGate - + A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.mdx index 524cbec7ead..e8f4b7c69a6 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # qiskit.circuit.library.RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -231,7 +231,7 @@ $$ ### label - + Return gate label **Return type** @@ -257,7 +257,7 @@ $$ ### params - + return instruction params. @@ -369,7 +369,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.mdx index 33e46ce5819..488055eebb9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # qiskit.circuit.library.RZXGate - + A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. @@ -255,19 +255,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -285,7 +285,7 @@ $$ ### label - + Return gate label **Return type** @@ -311,7 +311,7 @@ $$ ### params - + return instruction params. @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.mdx index 41e21c373d6..0104ab8d23a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # qiskit.circuit.library.RZZGate - + A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -229,19 +229,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -259,7 +259,7 @@ $$ ### label - + Return gate label **Return type** @@ -285,7 +285,7 @@ $$ ### params - + return instruction params. @@ -397,7 +397,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.mdx index d417119727b..3f1b9d76c2d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # qiskit.circuit.library.RealAmplitudes - + The real-amplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. It is called `RealAmplitudes` since the prepared quantum states will only have real amplitudes, the complex part is always 0. @@ -359,7 +359,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -718,7 +718,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + Return the circuit data (instructions and context). **Returns** @@ -899,7 +899,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -913,7 +913,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -959,7 +959,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -977,7 +977,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1019,7 +1019,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### global\_phase - + Return the global phase of the circuit in radians. @@ -1067,7 +1067,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1197,7 +1197,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1460,7 +1460,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1474,13 +1474,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1504,7 +1504,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1536,7 +1536,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1556,7 +1556,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1622,7 +1622,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1636,7 +1636,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1677,7 +1677,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1747,7 +1747,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qregs - + A list of the quantum registers associated with the circuit. @@ -1821,7 +1821,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1883,7 +1883,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1989,7 +1989,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.mdx index e61eae070dd..1fa473d5474 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # qiskit.circuit.library.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.mdx index e681efc0e5d..20c11843bcc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # qiskit.circuit.library.SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.mdx index 31e2ca561e0..5e3e7644c3c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # qiskit.circuit.library.SXGate - + The single-qubit Sqrt(X) gate ($\sqrt{X}$). **Matrix Representation:** @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -230,7 +230,7 @@ $$ ### label - + Return gate label **Return type** @@ -256,7 +256,7 @@ $$ ### params - + return instruction params. @@ -368,7 +368,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.mdx index d2a244f6d0b..d07c7691d51 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # qiskit.circuit.library.SXdgGate - + The inverse single-qubit Sqrt(X) gate. $$ @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.mdx index bbb9b3538d1..e55985c7c78 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # qiskit.circuit.library.SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.mdx index ee9a970ad95..2f3dfcb4adb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # qiskit.circuit.library.SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -229,7 +229,7 @@ $$ ### label - + Return gate label **Return type** @@ -255,7 +255,7 @@ $$ ### params - + return instruction params. @@ -367,7 +367,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.mdx index 1a154ec3844..debdfc447aa 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # qiskit.circuit.library.TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.mdx index 3728c913051..b977e816f7a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # qiskit.circuit.library.TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.mdx index 83b6e2c4464..6d2a7e4b673 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # qiskit.circuit.library.TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -381,7 +381,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -464,7 +464,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -474,7 +474,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -510,19 +510,19 @@ python_api_name: qiskit.circuit.library.TwoLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -740,7 +740,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -921,7 +921,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -981,7 +981,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1041,7 +1041,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1089,7 +1089,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1219,7 +1219,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1482,7 +1482,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1496,13 +1496,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1548,7 +1548,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1558,7 +1558,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1608,7 +1608,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1658,7 +1658,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1769,7 +1769,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1843,7 +1843,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1905,7 +1905,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2011,7 +2011,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.mdx index 1779ea7ff0e..974868d6f58 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # qiskit.circuit.library.U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -215,19 +215,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### params - + return instruction params. @@ -383,7 +383,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.mdx index ec6ce49d431..f900cabbae9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # qiskit.circuit.library.U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.mdx index 0988c3006d0..e1bd2b609fc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # qiskit.circuit.library.U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.mdx index 03bcceb0a06..3d48c7831a1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # qiskit.circuit.library.UGate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.mdx index 3f2203fbc7f..b0180930f3d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # qiskit.circuit.library.UniformDistribution - + A circuit to encode a discretized uniform distribution in qubit amplitudes. This simply corresponds to applying Hadamard gates on all qubits. @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.mdx index f1777082247..bd33801ed49 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # qiskit.circuit.library.WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -280,7 +280,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -439,7 +439,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -449,7 +449,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -485,19 +485,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -715,7 +715,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -928,7 +928,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1377,7 +1377,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1391,7 +1391,7 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. **Return type** @@ -1401,13 +1401,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_carry\_qubits - + The number of carry qubits required to compute the sum. Note that this is not necessarily equal to the number of ancilla qubits, these can be queried using `num_ancilla_qubits`. @@ -1423,7 +1423,7 @@ $$ ### num\_clbits - + Return number of classical bits. @@ -1447,7 +1447,7 @@ $$ ### num\_control\_qubits - + The number of additional control qubits required. Note that the total number of ancilla qubits can be obtained by calling the method `num_ancilla_qubits`. @@ -1471,7 +1471,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1481,13 +1481,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -1501,7 +1501,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -1537,7 +1537,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1620,7 +1620,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1694,7 +1694,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2843,7 +2843,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.mdx index 98d71f568f5..3484e52657d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # qiskit.circuit.library.XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.mdx index b6432b6e077..b652d54e237 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # qiskit.circuit.library.XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.XOR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.XOR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -453,19 +453,19 @@ python_api_name: qiskit.circuit.library.XOR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -683,7 +683,7 @@ python_api_name: qiskit.circuit.library.XOR ### data - + Return the circuit data (instructions and context). **Returns** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.XOR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1345,7 +1345,7 @@ python_api_name: qiskit.circuit.library.XOR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1397,13 +1397,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.XOR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.XOR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.mdx index 674193a1560..32233bb718d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # qiskit.circuit.library.YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.mdx index 1b54fc845ec..93b850710ee 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # qiskit.circuit.library.ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -439,7 +439,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -475,19 +475,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -705,7 +705,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1036,7 +1036,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1084,7 +1084,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1214,7 +1214,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1491,13 +1491,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1543,7 +1543,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1553,13 +1553,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1589,7 +1589,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1625,7 +1625,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1639,7 +1639,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1667,7 +1667,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1776,7 +1776,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1850,7 +1850,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1912,7 +1912,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2018,7 +2018,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.mdx index ee60248a181..af04e29e3cb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # qiskit.circuit.library.ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.mdx index 17311e5d784..ab259c70a55 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # qiskit.circuit.library.ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -328,7 +328,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -471,19 +471,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -882,7 +882,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -970,7 +970,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1032,7 +1032,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1080,7 +1080,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1210,7 +1210,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1473,7 +1473,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1487,13 +1487,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1517,7 +1517,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1539,7 +1539,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1549,13 +1549,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1621,7 +1621,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1635,7 +1635,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1663,7 +1663,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1702,7 +1702,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1772,7 +1772,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1846,7 +1846,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1908,7 +1908,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2014,7 +2014,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.mdx index b1172f7de65..690f475c910 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # qiskit.circuit.library.iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. @@ -224,19 +224,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### params - + return instruction params. @@ -408,7 +408,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.mdx index 3676f602c6f..c4c872cb726 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # qiskit.dagcircuit.DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. @@ -201,7 +201,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -344,7 +344,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** @@ -389,7 +389,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### global\_phase - + Return the global phase of the circuit. @@ -469,7 +469,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### node\_counter - + Returns the number of nodes in the dag. @@ -736,7 +736,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### wires - + Return a list of the wires in order. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.mdx index a27257781ea..2223f873a35 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.mdx index 7845dc568a1..e15c1b9546d 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # qiskit.dagcircuit.DAGDepNode - + Object to represent the information at a node in the DAGDependency(). It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -56,19 +56,19 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.mdx index 76f1d8958db..5c13d2d6885 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # qiskit.dagcircuit.DAGDependency - + Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed. @@ -114,7 +114,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -293,7 +293,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### global\_phase - + Return the global phase of the circuit. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.mdx index 37d16e30282..1345c274f80 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # qiskit.dagcircuit.DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -43,25 +43,25 @@ python_api_name: qiskit.dagcircuit.DAGNode ### condition - + Returns the condition of the node.op ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** @@ -82,7 +82,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### wire - + Returns the Bit object, else None. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.mdx index 9f0ca491d33..afc8f1ae8b3 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # qiskit.extensions.HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t @@ -208,19 +208,19 @@ python_api_name: qiskit.extensions.HamiltonianGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### params - + return instruction params. @@ -380,7 +380,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.26/qiskit.extensions.Initialize.mdx index 65cdea9aaf6..f18e987a2ab 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.26/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # qiskit.extensions.Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers. Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. @@ -146,19 +146,19 @@ python_api_name: qiskit.extensions.Initialize ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.extensions.Initialize ### params - + return instruction params. @@ -294,7 +294,7 @@ python_api_name: qiskit.extensions.Initialize ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.mdx index a27821f84ac..9a229bd9a2a 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # qiskit.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -163,7 +163,7 @@ python_api_name: qiskit.extensions.Snapshot ### label - + Return snapshot label @@ -185,7 +185,7 @@ python_api_name: qiskit.extensions.Snapshot ### params - + return instruction params. @@ -239,7 +239,7 @@ python_api_name: qiskit.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.mdx index 9dde9d4a6f5..f618d6b6234 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # qiskit.extensions.UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. @@ -207,19 +207,19 @@ python_api_name: qiskit.extensions.UnitaryGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### params - + return instruction params. @@ -379,7 +379,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.mdx index ec0d88deb2b..1fc4c51b85a 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index d7f67001b29..6eb9cad9b70 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # qiskit.finance.components.uncertainty\_problems.EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -151,7 +151,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 6fb62e94231..29664f6cbe0 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # qiskit.finance.components.uncertainty\_problems.EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -155,7 +155,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 9146304c8eb..743382d8479 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # qiskit.finance.components.uncertainty\_problems.FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. @@ -157,7 +157,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.mdx index b12af8df2e6..f94fc28a515 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # qiskit.finance.data\_providers.BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -17,7 +17,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -136,7 +136,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.mdx index fbf9b10dd1d..1c540f4e596 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # qiskit.finance.data\_providers.DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.mdx index 62a79450642..81ea451df61 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # qiskit.finance.data\_providers.ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.mdx index 4d9c5fbfb65..b204dd97849 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # qiskit.finance.data\_providers.RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type start: `datetime` :param start: first data point :type end: `datetime` :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.mdx index dd8223e6cd4..d15da364bae 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # qiskit.finance.data\_providers.StockMarket - + Stock Market enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 023b8271d31..e835736bd3a 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # qiskit.finance.data\_providers.WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.mdx index 7191e3eb1c2..6127b66fd16 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # qiskit.finance.data\_providers.YahooDataProvider - + Yahoo data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.mdx index f3d425d3b47..0fcf9661fcc 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # qiskit.ignis.characterization.AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.mdx index 81c6416d1a0..3895433f18f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # qiskit.ignis.characterization.AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 5cae1dd86fb..835a2557461 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # qiskit.ignis.characterization.AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.mdx index eff4166e29e..6da3dd6f598 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # qiskit.ignis.characterization.AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 3f7298c8cac..6c1f702e96d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # qiskit.ignis.characterization.BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.mdx index 67337efff90..e3b8343d1fc 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # qiskit.ignis.characterization.BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.mdx index c6d8618859b..96fea6f87d2 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # qiskit.ignis.characterization.DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.mdx index 451250e59f0..130ea82fb23 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # qiskit.ignis.characterization.RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ @@ -63,7 +63,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.mdx index f891073becd..c637555fae3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # qiskit.ignis.characterization.T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. @@ -75,7 +75,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -223,7 +223,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -233,7 +233,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.mdx index 48c153a777b..1b5f329eb5f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # qiskit.ignis.characterization.T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -176,7 +176,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -224,7 +224,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -234,7 +234,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.mdx index c32236e17fd..d3fed73eabd 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # qiskit.ignis.characterization.T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -242,7 +242,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -252,7 +252,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.mdx index 07adf6c7edb..ff69a1f4e7f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # qiskit.ignis.characterization.ZZFitter - + ZZ fitter ### \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.mdx index d9f7edb1ce8..19a3582b148 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # qiskit.ignis.logging.IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.mdx index 59417cb2165..b6e9c3ba0a3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # qiskit.ignis.logging.IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.mdx index 1fc8c56fc0e..1adb06a713e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # qiskit.ignis.logging.IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.mdx index 77dafde2131..5625ef587c9 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # qiskit.ignis.measurement.DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 231150bc93a..c3f15566789 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # qiskit.ignis.measurement.IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -85,19 +85,19 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### expected\_states - + Returns the expected states used to train the discriminator. ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. ### fitted - + True if the discriminator has been fitted to calibration data. @@ -236,7 +236,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 960417a844c..1cc340b8f18 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # qiskit.ignis.measurement.LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index deca26b8d9b..63dcc749e1b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # qiskit.ignis.measurement.QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index 3198ef0729f..bb38c72f3ac 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # qiskit.ignis.measurement.SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -99,7 +99,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index b32b4fedc2b..f3bdad81056 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # qiskit.ignis.mitigation.CTMPExpvalMeasMitigator - + N-qubit CTMP measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 2c346fc747f..41bc15188f2 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # qiskit.ignis.mitigation.CompleteExpvalMeasMitigator - + N-qubit measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index edb0220a002..311cfe9dff7 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # qiskit.ignis.mitigation.CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits @@ -69,13 +69,13 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### cal\_matrix - + Return cal\_matrix. ### filter - + Return a measurement filter using the cal matrix. @@ -92,7 +92,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### qubit\_list - + Return list of qubits. @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### state\_labels - + Return state\_labels. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index bba1c825c89..5d4e0fb721e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter - + Expectation value measurement error mitigator calibration fitter. See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter ### mitigator - + Return the fitted mitigator object diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.mdx index bad192ad4c9..4e49d3d9ca9 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # qiskit.ignis.mitigation.MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. @@ -87,13 +87,13 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter ### cal\_matrix - + Return cal\_matrix. ### state\_labels - + return the state label ordering of the cal matrix diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index 1bf39854ce1..2393eb6c6a4 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # qiskit.ignis.mitigation.TensoredExpvalMeasMitigator - + 1-qubit tensor product measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.mdx index e95839c22a7..4ea9dd389a6 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # qiskit.ignis.mitigation.TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### cal\_matrices - + Return cal\_matrices. @@ -132,19 +132,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### nqubits - + Return the number of qubits. See also MeasurementFilter.apply() ### qubit\_list\_sizes - + Return \_qubit\_list\_sizes. ### substate\_labels\_list - + Return \_substate\_labels\_list diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index d8f51cfe1c5..86f411e4057 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # qiskit.ignis.mitigation.TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. @@ -72,19 +72,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### cal\_matrices - + Return cal\_matrices. ### filter - + Return a measurement filter using the cal matrices. ### nqubits - + Return \_qubit\_list\_sizes. @@ -134,7 +134,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### substate\_labels\_list - + Return \_substate\_labels\_list. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.mdx index 1e10b61f70d..ab2a0651a33 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # qiskit.ignis.verification.AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.mdx index cd548abfdec..ff65a5b3863 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # qiskit.ignis.verification.AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.mdx index 2674216d626..dd4551bc7e5 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # qiskit.ignis.verification.BConfig - + This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.mdx index 84272747b04..942c0a7ad16 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # qiskit.ignis.verification.CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. **References** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -203,13 +203,13 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### key - + Return a string representation of a CNOT-dihedral object. ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -249,7 +249,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 53779d9ea3f..e17ccfa97fb 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # qiskit.ignis.verification.CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. @@ -88,19 +88,19 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### cliff\_lengths - + Return group elements lengths. ### fit - + Return fit as a 2 element list. ### fit\_cnotdihedral - + Return cnotdihedral fit parameters. @@ -158,43 +158,43 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### raw\_data - + Return raw\_data as 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_X - + Return the cnotdihedral X fitter. ### rbfit\_Z - + Return the cnotdihedral Z fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.mdx index bef77c48908..8c6b3996733 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # qiskit.ignis.verification.GatesetTomographyFitter - + Initialize gateset tomography fitter with experimental data. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.mdx index 9034971fc56..5a181f0ceab 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # qiskit.ignis.verification.GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.mdx index 18c3ddd3b1a..d0763c4eb6a 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # qiskit.ignis.verification.InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. @@ -92,13 +92,13 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit as a 2 element list. @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### fit\_int - + Return interleaved fit parameters. @@ -155,43 +155,43 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### raw\_data - + Return raw\_data as a 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_int - + Return the interleaved RB fitter. ### rbfit\_std - + Return the original RB fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.mdx index 5b2620265c2..58a4ad6472e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # qiskit.ignis.verification.Plotter - + Various plots of the ground state in MQC and PO experiments ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 4986354d75e..8efae59b513 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # qiskit.ignis.verification.ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### data - + Return tomography data @@ -146,13 +146,13 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.mdx index e158e83ebb6..034e74b0c4f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # qiskit.ignis.verification.PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -112,13 +112,13 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return the purity fit parameters. @@ -161,37 +161,37 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_pur - + Return the purity RB fitter. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.mdx index 155d27ff3fb..5cfe7c30e9d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # qiskit.ignis.verification.QVFitter - + Class for fitters for quantum volume. **Parameters** @@ -152,25 +152,25 @@ python_api_name: qiskit.ignis.verification.QVFitter ### depths - + Return depth list. ### heavy\_output\_counts - + Return the number of heavy output counts as measured. ### heavy\_output\_prob\_ideal - + Return the heavy output probability ideally. ### heavy\_outputs - + Return the ideal heavy outputs dictionary. @@ -254,7 +254,7 @@ python_api_name: qiskit.ignis.verification.QVFitter ### qubit\_lists - + Return depth list. @@ -274,13 +274,13 @@ python_api_name: qiskit.ignis.verification.QVFitter ### results - + Return all the results. ### ydata - + Return the average and std of the output probability. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.mdx index 685ea07071c..985a5a4a60a 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # qiskit.ignis.verification.RBFitter - + Class for fitters for randomized benchmarking. **Parameters** @@ -91,13 +91,13 @@ python_api_name: qiskit.ignis.verification.RBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit. @@ -151,31 +151,31 @@ python_api_name: qiskit.ignis.verification.RBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.mdx index 8e0aa13fe2f..c6f3feb5f1d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # qiskit.ignis.verification.RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.mdx index 40c093860dc..4b648fd4806 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # qiskit.ignis.verification.StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### data - + Return tomography data @@ -134,13 +134,13 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.mdx index 210024aa6c3..e726f44185c 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # qiskit.ignis.verification.TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### data - + Return tomography data @@ -139,13 +139,13 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.mdx index 5e0f2d41b12..d0ec76e4341 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # qiskit.ml.circuit.library.RawFeatureVector - + The raw feature vector circuit. This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. @@ -262,7 +262,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -311,7 +311,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -321,7 +321,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -357,19 +357,19 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -587,7 +587,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### data - + Return the circuit data (instructions and context). **Returns** @@ -794,7 +794,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### feature\_dimension - + Return the feature dimension. **Return type** @@ -814,7 +814,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -832,7 +832,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -850,7 +850,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### global\_phase - + Return the global phase of the circuit in radians. @@ -1263,7 +1263,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1277,13 +1277,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1315,7 +1315,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1325,7 +1325,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1355,7 +1355,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ordered\_parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1375,7 +1375,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1462,7 +1462,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qregs - + A list of the quantum registers associated with the circuit. @@ -1536,7 +1536,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.mdx index c4c9377bab4..b77a9f68a00 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # qiskit.opflow\.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms. @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -152,7 +152,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -190,7 +190,7 @@ python_api_name: qiskit.opflow.OperatorBase ### instance\_id - + Return the unique instance id. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -232,7 +232,7 @@ python_api_name: qiskit.opflow.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -246,13 +246,13 @@ python_api_name: qiskit.opflow.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -274,7 +274,7 @@ python_api_name: qiskit.opflow.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -338,7 +338,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.mdx index ba7506b1ae2..6c84da9a7c5 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.mdx index 189f13d6312..30793bcabc2 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # qiskit.opflow\.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.mdx index cac7b4701f0..2cb65167d0d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # qiskit.opflow\.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -91,7 +91,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.mdx index ca78c680dc6..0a8236f3414 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: 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. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.mdx index 68aa401408c..c101a7e72fc 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # qiskit.opflow\.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.mdx index b0a4339ac41..2a88b2e95df 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # qiskit.opflow\.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.mdx index ca5f23f44a6..1149c7de676 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # qiskit.opflow\.converters.TwoQubitReduction - + Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.mdx index fb6942b9eac..319fad60d56 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # qiskit.opflow\.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.mdx index 3015e63ad6d..4307ba9028e 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # qiskit.opflow\.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.mdx index 343c2ba7f2c..f7a8b7072f4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # qiskit.opflow\.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -339,7 +339,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.mdx index 5c1c0bb0633..37584d0b1a9 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: 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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 86fb846cda4..802993f8c7e 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # qiskit.opflow\.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.mdx index 973696c8101..d4e2334de57 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # qiskit.opflow\.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.mdx index c5d621e5685..45182a39450 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # qiskit.opflow\.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.mdx index 5e3589b216d..67b0c31e2c4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # qiskit.opflow\.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.mdx index 8f8d35f2176..8e93902e7f4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # qiskit.opflow\.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 77e79b9b50f..13706eb8d80 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # qiskit.opflow\.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.mdx index 0949a77d78f..ecdca70e797 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # qiskit.opflow\.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.mdx index bddf7d66280..f0c270cb8d2 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # qiskit.opflow\.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.mdx index 87d88b0445c..20138e0222c 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # qiskit.opflow\.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.mdx index 52ab8fcb878..c8a8c0bed3d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # qiskit.opflow\.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.mdx index a348a6f16a6..4db723e487f 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # qiskit.opflow\.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.mdx index fe0b5c9a89a..50f40847244 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # qiskit.opflow\.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.mdx index 17c9d23cd68..afc869f6803 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # qiskit.opflow\.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.mdx index b3eb5b129e4..1755df95faa 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # qiskit.opflow\.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.mdx index a62cbcf624c..6e0d6fa835c 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # qiskit.opflow\.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.mdx index d05da2b585d..b187e1a419f 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # qiskit.opflow\.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.mdx index bbeb6738ac6..e38607f9e2f 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # qiskit.opflow\.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.mdx index 2970f50da08..45700a4921e 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # qiskit.opflow\.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.mdx index 8ceb0bef3f3..26d09c88ce8 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # qiskit.opflow\.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.mdx index c5d80b1cf27..180e522737c 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # qiskit.opflow\.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -147,7 +147,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.mdx index 891b8ba0d34..5cdd4ea3e1c 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # qiskit.opflow\.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parameterized quantum state, where QFI is: @@ -97,7 +97,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -116,7 +116,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.mdx index 1671ffe435a..4835ceb5234 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # qiskit.opflow\.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.mdx index d974f06623f..1321ff3a1e0 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # qiskit.opflow\.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -358,7 +358,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.mdx index f721205a1dd..c8a771aaffa 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # qiskit.opflow\.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### instance\_id - + Return the unique instance id. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -384,7 +384,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.mdx index 918ec65c28a..b5691decef7 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # qiskit.opflow\.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -392,7 +392,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.mdx index ca947fa5de4..e4935df5787 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # qiskit.opflow\.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### instance\_id - + Return the unique instance id. **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -357,7 +357,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.mdx index 988ed0b4d73..f8475d2ed87 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # qiskit.opflow\.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -345,7 +345,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.mdx index 1b0a78fbd83..36bb26febc4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # qiskit.opflow\.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -349,7 +349,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.mdx index efc160b9f97..fa9f4240cb7 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # qiskit.opflow\.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### instance\_id - + Return the unique instance id. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -301,7 +301,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 3db92a8dca2..d46c8e87812 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # qiskit.opflow\.primitive\_ops.PauliSumOp - + Class for Operators backend by Terra’s `SparsePauliOp` class. **Parameters** @@ -144,7 +144,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -248,7 +248,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -423,7 +423,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 1a9e11ea32b..a8370c8dbbd 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # qiskit.opflow\.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### instance\_id - + Return the unique instance id. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -341,7 +341,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 331c1a2773d..ccc36bd63f4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # qiskit.opflow\.primitive\_ops.TaperedPauliSumOp - + Class for PauliSumOp after tapering **Parameters** @@ -145,7 +145,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -249,7 +249,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -268,7 +268,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -424,7 +424,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -593,7 +593,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### z2\_symmetries - + Z2 symmetries which the Operator has. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 9a03fe2796a..59e45423a36 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # qiskit.opflow\.primitive\_ops.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian. @@ -94,7 +94,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -114,19 +114,19 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### tapering\_values - + returns tapering values diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.mdx index a777edec949..f29696eb867 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # qiskit.opflow\.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -166,7 +166,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### instance\_id - + Return the unique instance id. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -429,7 +429,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.mdx index 59b7bac50bc..a67e73011a8 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # qiskit.opflow\.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -260,7 +260,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -368,7 +368,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.mdx index 495815205a6..e8c4153425d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # qiskit.opflow\.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -329,7 +329,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.mdx index 7a59f2bec8c..70c79967b23 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # qiskit.opflow\.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index a87bee5dd45..f4b12c18f38 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # qiskit.opflow\.state\_fns.SparseVectorStateFn - + A class for sparse state functions and measurements in vector representation. This class uses `scipy.sparse.spmatrix` for the internal representation. @@ -143,7 +143,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -333,7 +333,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.mdx index e59a578cbd1..8dfd3d675cd 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # qiskit.opflow\.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.mdx index 39840549f68..5d7b4797e1b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # qiskit.opflow\.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.mdx index 57f4848eb03..cf80f51af66 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.mdx index c6a662e3b43..a7214bb57c2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # qiskit.optimization.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 2a05542589f..fac5d6db3ec 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # qiskit.optimization.algorithms.ADMMOptimizationResult - + ADMMOptimization Result. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### state - + returns state **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.mdx index ce8fa022986..aab119a9138 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # qiskit.optimization.algorithms.ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer ### parameters - + Returns current parameters of the optimizer. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.mdx index f0389705c6e..90db1cd91a2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # qiskit.optimization.algorithms.ADMMParameters - + Defines a set of parameters for ADMM optimizer. Defines parameters for ADMM optimizer and their default values. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.mdx index 4595f865b33..6614f4c70e0 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # qiskit.optimization.algorithms.ADMMState - + Internal computation state of the ADMM implementation. The state keeps track of various variables are stored that are being updated during problem solving. The values are relevant to the problem being solved. The state is recreated for each optimization problem. State is returned as the third value. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 6e923b0ccd7..c004ba4e818 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # qiskit.optimization.algorithms.CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.mdx index 706d15875e5..69931748b27 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # qiskit.optimization.algorithms.CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index e9ec74f18af..034e93e4f26 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # qiskit.optimization.algorithms.GroverOptimizationResult - + A result object for Grover Optimization methods. Constructs a result object with the specific Grover properties. @@ -69,7 +69,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### intermediate\_fval - + Getter of the intermediate fval **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_input\_qubits - + Getter of n\_input\_qubits **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_output\_qubits - + Getter of n\_output\_qubits **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### operation\_counts - + Get the operation counts. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### threshold - + Getter of the threshold of Grover algorithm. **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.mdx index 7805c09a8d5..c017b2493a5 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # qiskit.optimization.algorithms.GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer ### quantum\_instance - + The quantum instance to run the circuits. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.mdx index 6b7fed092a7..707027da784 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # qiskit.optimization.algorithms.IntermediateResult - + Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 5f41710e8c8..94a19c249b8 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # qiskit.optimization.algorithms.MinimumEigenOptimizationResult - + Minimum Eigen Optimizer Result. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### min\_eigen\_solver\_result - + Returns a result object obtained from the instance of `MinimumEigensolver`. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_samples - + Returns the list of raw solution samples of `MinimumEigensolver`. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index ad5c27f7431..c85991d6206 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # qiskit.optimization.algorithms.MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer ### min\_eigen\_solver - + Returns the minimum eigensolver. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 990cb906264..46f8728fbc6 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # qiskit.optimization.algorithms.MultiStartOptimizer - + An abstract class that implements multi start optimization and should be sub-classed by other optimizers. Constructs an instance of this optimizer. @@ -48,7 +48,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index be4e56a9955..7c401461d24 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # qiskit.optimization.algorithms.OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.mdx index ae2b033deed..8094132f7ed 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # qiskit.optimization.algorithms.OptimizationResult - + A base class for optimization results. The optimization algorithms return an object of the type `OptimizationResult` with the information about the solution obtained. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index a0eff974aad..3c3dc40eb73 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # qiskit.optimization.algorithms.OptimizationResultStatus - + Termination status of an optimization algorithm. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 759447cef02..674ed729cf0 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult - + Recursive Eigen Optimizer Result. Constructs an instance of the result class. @@ -60,7 +60,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### fval - + Returns the optimal function value. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### history - + Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### replacements - + Returns a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### samples - + Returns the list of solution samples **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index af82acf3b40..3e8a9033c99 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index bbede36b2c3..eac72c40a44 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # qiskit.optimization.algorithms.SlsqpOptimizationResult - + SLSQP optimization result, defines additional properties that may be returned by the optimizer. Constructs a result object with properties specific to SLSQP. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fx - + Returns the final value of the objective function being actually optimized. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### imode - + Returns the exit mode from the optimizer. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### its - + Returns the number of iterations **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -126,7 +126,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### smode - + Returns message describing the exit mode from the optimizer. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index e164c53a9ed..f7bc6a8894e 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # qiskit.optimization.algorithms.SlsqpOptimizer - + The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.mdx index 4396d597a6f..1c4fdf310cb 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # qiskit.optimization.algorithms.SolutionSample - + A sample of an optimization solution ### x diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx index 92d3d3d31f2..7eb8cf5d8d2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx @@ -32,12 +32,12 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord - + Alias for field number 2 @@ -49,7 +49,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### dim - + Alias for field number 1 @@ -63,13 +63,13 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### name - + Alias for field number 0 #### w - + Alias for field number 3 diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.mdx index 773b2b14e50..aa541790e65 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # qiskit.optimization.converters.InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality ### mode - + Returns the mode of the converter **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.mdx index 781285ebc33..a784e593b16 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # qiskit.optimization.converters.IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index 613aef79e7f..6b00cbc52a9 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # qiskit.optimization.converters.LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. **Parameters** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 8e9d417f504..f9144290aa3 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # qiskit.optimization.converters.QuadraticProgramConverter - + An abstract class for converters of quadratic programs in Qiskit’s optimization module. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index afbfbf0c222..654306d442b 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # qiskit.optimization.converters.QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.mdx index cacfebafefa..198e25adc32 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # qiskit.optimization.problems.Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -57,7 +57,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.mdx index c6cade6be8f..8012335c854 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # qiskit.optimization.problems.LinearConstraint - + Representation of a linear constraint. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.mdx index 17f8b1b328d..b94cbc7d5eb 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # qiskit.optimization.problems.LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.mdx index 51854c923bc..ff30982abce 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # qiskit.optimization.problems.QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. @@ -81,7 +81,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.mdx index 6bf0a82b458..fb9d9b18740 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # qiskit.optimization.problems.QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.mdx index ccd36875b0e..065d86bfc4d 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # qiskit.optimization.problems.QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### sense - + Returns the sense of the objective function. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.mdx index 2b72e18387b..a0c1ca22a8e 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # qiskit.optimization.problems.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.mdx index fce41233579..2ed7c5c3895 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # qiskit.optimization.problems.QuadraticProgramElement - + Interface class for all objects that have a parent QuadraticProgram. Initialize object with parent QuadraticProgram. @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.mdx index 9b632a061b3..714b11e33fb 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # qiskit.optimization.problems.Variable - + Representation of a variable. Creates a new Variable. @@ -86,7 +86,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.26/qiskit.providers.Backend.mdx index 4c622d7d5d0..275990c1ea9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # qiskit.providers.Backend - + Base common type for all versioned Backend abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.mdx index 0f3f01bf612..a7b87eb321a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.26/qiskit.providers.BackendV1.mdx index e29d93917b7..424be0b0406 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # qiskit.providers.BackendV1 - + Abstract class for Backends This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.BackendV1 ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. @@ -129,7 +129,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.mdx index 69b37a70800..16e3917607f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # qiskit.providers.BaseBackend - + Legacy Base class for backends. Base class for backends. @@ -26,7 +26,7 @@ python_api_name: qiskit.providers.BaseBackend ### \_\_init\_\_ - + Base class for backends. This method should initialize the module and its configuration, and raise an exception if a component of the module is not available. @@ -112,7 +112,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.BaseJob.mdx index 9a1e3bf93e2..b541b35b6da 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # qiskit.providers.BaseJob - + Legacy Class to handle asynchronous jobs Initializes the asynchronous job. @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -104,7 +104,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -120,13 +120,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.mdx index f98913d12c2..6375f151453 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # qiskit.providers.BaseProvider - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.Job.mdx b/docs/api/qiskit/0.26/qiskit.providers.Job.mdx index 1d10a1b77b7..cda7319d030 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # qiskit.providers.Job - + Base common type for all versioned Job abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.26/qiskit.providers.JobError.mdx index 3eb1b427e63..d3a30520088 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.26/qiskit.providers.JobStatus.mdx index e67e057e5fb..4fb1308aaae 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # qiskit.providers.JobStatus - + Class for job status enumerated type. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.mdx index 3b92d060cc1..a1d801b683e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.26/qiskit.providers.JobV1.mdx index d749faf9bc1..1231d7a0949 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # qiskit.providers.JobV1 - + Class to handle jobs This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -130,13 +130,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.26/qiskit.providers.Options.mdx b/docs/api/qiskit/0.26/qiskit.providers.Options.mdx index 1572b839c81..46b37d5e605 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # qiskit.providers.Options - + Base options object This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. diff --git a/docs/api/qiskit/0.26/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.26/qiskit.providers.Provider.mdx index 77cb7c78f67..70ba4705dc6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # qiskit.providers.Provider - + Base common type for all versioned Provider abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.mdx index 87199668b9c..399803c6bc9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # qiskit.providers.ProviderV1 - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.mdx index 8b4c8b210ef..131f42829eb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.mdx index 5f19e6662bc..db6c76b8924 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.mdx index 7d436aa2dcd..276c34ed48b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # qiskit.providers.aer.AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.mdx index 4cc9bbc4687..c52b9c43fea 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # qiskit.providers.aer.AerProvider - + Provider for Qiskit Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.mdx index 894385f2b2c..5166e47fa6b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # qiskit.providers.aer.AerSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.mdx index df0ca228569..70031ecd02c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # qiskit.providers.aer.PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.mdx index 43e90230390..5eae2e7dda2 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # qiskit.providers.aer.QasmSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.mdx index 9eb2cb364c1..6baabe9c159 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # qiskit.providers.aer.StatevectorSimulator - + Ideal quantum circuit statevector simulator **Configurable Options** @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.mdx index a6675a75b9b..0868ccf5ad1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # qiskit.providers.aer.UnitarySimulator - + Ideal quantum circuit unitary simulator. **Configurable Options** @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.mdx index 124d02898e9..420ac5f091c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # qiskit.providers.aer.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -134,25 +134,25 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### label - + Return snapshot label @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### params - + return instruction params. @@ -246,7 +246,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 306c587679e..c0b66fdaddb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # qiskit.providers.aer.extensions.SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -136,25 +136,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### label - + Return snapshot label @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### params - + return instruction params. @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### snapshot\_type - + Return snapshot type @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index efd3dc2dfd0..beef7a5cb88 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # qiskit.providers.aer.extensions.SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create an expectation value snapshot instruction. @@ -140,25 +140,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### label - + Return snapshot label @@ -198,7 +198,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### snapshot\_type - + Return snapshot type @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index d95040a3569..42a19cf77cf 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # qiskit.providers.aer.extensions.SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -138,25 +138,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### label - + Return snapshot label @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### params - + return instruction params. @@ -250,7 +250,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### snapshot\_type - + Return snapshot type @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index cce75df839f..5513c400507 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # qiskit.providers.aer.extensions.SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index aaf94825caa..da85a096971 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # qiskit.providers.aer.extensions.SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.mdx index be073927071..b7328f95935 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # qiskit.providers.aer.library.SaveAmplitudes - + Save complex statevector amplitudes. Instruction to save complex statevector amplitudes. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### params - + return instruction params. @@ -249,7 +249,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 44d7c004322..f89b8934cc0 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # qiskit.providers.aer.library.SaveAmplitudesSquared - + Save squared statevector amplitudes (probabilities). Instruction to save squared statevector amplitudes (probabilities). @@ -133,19 +133,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -179,7 +179,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### params - + return instruction params. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.mdx index a24504ca663..6e7ba54dc69 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # qiskit.providers.aer.library.SaveDensityMatrix - + Save a reduced density matrix. Create new instruction to save the simulator reduced density matrix. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.mdx index 7926573f78c..771933d3012 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # qiskit.providers.aer.library.SaveExpectationValue - + Save expectation value of an operator. Instruction to save the expectation value of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 5efb040e989..09aa0bbf8c8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # qiskit.providers.aer.library.SaveExpectationValueVariance - + Save expectation value and variance of an operator. Instruction to save the expectation value and variance of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.mdx index cb0c6d71c32..935ff83b4e6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # qiskit.providers.aer.library.SaveMatrixProductState - + Save matrix product state instruction Create new instruction to save the matrix product state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.mdx index f249fef282a..c3ea4d78da5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # qiskit.providers.aer.library.SaveProbabilities - + Save measurement outcome probabilities vector. Instruction to save measurement probabilities vector. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index a2b8dd8d06a..efee5fd5d58 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # qiskit.providers.aer.library.SaveProbabilitiesDict - + Save measurement outcome probabilities dict. Instruction to save measurement probabilities dict. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.mdx index 2ddab3d3703..532448045c1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # qiskit.providers.aer.library.SaveStabilizer - + Save Stabilizer instruction Create new instruction to save the stabilizer simulator state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.mdx index 1f88f4e933e..55ce2af7211 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # qiskit.providers.aer.library.SaveState - + Save simulator state The format of the saved state depends on the simulation method used. @@ -135,19 +135,19 @@ python_api_name: qiskit.providers.aer.library.SaveState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -181,7 +181,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### params - + return instruction params. @@ -253,7 +253,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.mdx index 5bf9d2df3e9..89e96cdc9bb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # qiskit.providers.aer.library.SaveStatevector - + Save statevector Create new instruction to save the simulator statevector. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 6e3c47d75e9..9030afc159d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # qiskit.providers.aer.library.SaveStatevectorDict - + Save statevector as ket-form dictionary. Create new instruction to save the simulator statevector as a dict. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.mdx index b4c232ab8ba..d1327e1b14c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # qiskit.providers.aer.library.SaveSuperOp - + Save a SuperOp matrix. Create new instruction to save the superop simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.mdx index 3c482c9b6df..5017a57359c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # qiskit.providers.aer.library.SaveUnitary - + Save Unitary Create new instruction to save the unitary simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.mdx index 46e70a5b43a..c3c2c6bb8c7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # qiskit.providers.aer.library.SetDensityMatrix - + Set density matrix state of the simulator Create new instruction to set the density matrix state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.mdx index ccbc1addb72..ec56b616cd3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # qiskit.providers.aer.library.SetMatrixProductState - + Set the matrix product state of the simulator Create new instruction to set the matrix product state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.mdx index ba27f19829a..ffc5da2cab4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # qiskit.providers.aer.library.SetStabilizer - + Set the Clifford stabilizer state of the simulator Create new instruction to set the Clifford stabilizer state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.mdx index 2ac69a2626d..491db2db87c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # qiskit.providers.aer.library.SetStatevector - + Set the statevector state of the simulator Create new instruction to set the statevector state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.mdx index fef264d4699..28f49f0dbe7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # qiskit.providers.aer.library.SetSuperOp - + Set superop state of the simulator Create new instruction to set the superop simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.mdx index 13bf5ced8e3..5c2c3d28e7a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # qiskit.providers.aer.library.SetUnitary - + Set unitary state of the simulator Create new instruction to set the unitary simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.mdx index 0dc4d932729..34f9b3eb09b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # qiskit.providers.aer.noise.NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -211,13 +211,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### basis\_gates - + Return basis\_gates for compiling to the noise model. ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -279,7 +279,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** @@ -307,13 +307,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### noise\_instructions - + Return the set of noisy instructions for this noise model. ### noise\_qubits - + Return the set of noisy qubits for this noise model. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.mdx index 74b55875e7f..baf24e9adea 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # qiskit.providers.aer.noise.QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -113,13 +113,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### atol - + The default absolute tolerance parameter for float comparisons. ### circuits - + Return the list of error circuits. @@ -231,7 +231,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -259,31 +259,31 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### probabilities - + Return the list of error probabilities. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. ### size - + Return the number of error circuit. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.mdx index 5ade73205a5..c80abb84bb6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # qiskit.providers.aer.noise.ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -105,7 +105,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### atol - + The default absolute tolerance parameter for float comparisons. @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -222,25 +222,25 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### probabilities - + Return the readout error probabilities matrix. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 36fd9160769..2bbe1550693 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # qiskit.providers.aer.pulse.PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.mdx index 614c2a792a2..0fa61f4fa8b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # qiskit.providers.aer.utils.NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ### \_\_init\_\_ @@ -74,7 +74,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -107,13 +107,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -188,7 +188,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.mdx index b2484d426e2..12be712f6d5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.mdx index b63b6e3b53e..0b5583d413b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # qiskit.providers.basicaer.BasicAerJob - + BasicAerJob class. Initializes the asynchronous job. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.mdx index c1939d01626..7d4a7713428 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # qiskit.providers.basicaer.BasicAerProvider - + Provider for Basic Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 812266ea5a5..3223ff61ecb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # qiskit.providers.basicaer.QasmSimulatorPy - + Python implementation of a qasm simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index e7b59279ebc..e830fe662f3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # qiskit.providers.basicaer.StatevectorSimulatorPy - + Python statevector simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 9ca017e38d9..d995e3d1ea7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # qiskit.providers.basicaer.UnitarySimulatorPy - + Python implementation of a unitary simulator. Initialize a backend class @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.mdx index 15123f0bf72..f1163170e94 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # qiskit.providers.ibmq.AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### backend - + Return the backend service. **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### experiment - + Return the experiment service. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### random - + Return the random number service. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### runtime - + Return the runtime service. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.mdx index 3678c1c1aae..10acf53b7c1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # qiskit.providers.ibmq.BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 601847bc6c2..6a3d66378b0 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index c78c6e04dd3..492b5cf27d0 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5487a58a40b..056213974ed 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 3a415d1acd9..e8141908b73 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.mdx index 7cfaf8d0cbf..4aa0562d1f5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 9b398490eab..8d8798a15c4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.mdx index 1c8225bbc15..caf3a2032ff 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # qiskit.providers.ibmq.IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -266,7 +266,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.mdx index fbcc5b17465..1130f2e782d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 0cb4e7f9044..5c3c357c8cb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.mdx index 04f19c55e67..546afbcf13c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.mdx index 48b2470876a..a530604a585 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # qiskit.providers.ibmq.IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 8d602130338..1ce7cbdf12c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.mdx index b4c59693b26..f624622c671 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.mdx index b0c5c8fcb85..6d6f4db95b9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # qiskit.providers.ibmq.IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.mdx index da84ec11df6..9a45e822d33 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.mdx index 591fbadbdf2..87966534b0a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # qiskit.providers.ibmq.RunnerResult - + Result class for Qiskit Runtime program circuit-runner. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.mdx index 19d9414d67a..a3d5ee39fad 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # qiskit.providers.ibmq.credentials.Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 9496e0db150..87315a7ce09 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 1f08b192f14..fc29e5fdbe6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 03ea419fc86..12458b49fe5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.mdx index 53603034a20..1e20bfc39c2 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult # qiskit.providers.ibmq.experiment.AnalysisResult - + Class representing an analysis result for an experiment. AnalysisResult constructor. @@ -72,7 +72,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### quality - + Return the analysis result quality. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### uuid - + Return UUID of this analysis result. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.mdx index f701ff053e7..ec0aa03124b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment # qiskit.providers.ibmq.experiment.Experiment - + Class representing an experiment. Experiment constructor. @@ -140,7 +140,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### analysis\_results - + Return analysis results associated with this experiment. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### backend\_name - + Return the experiment’s backend name. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### end\_datetime - + Return the timestamp when the experiment ended. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -199,7 +199,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### group - + Return the experiment’s group. **Return type** @@ -209,7 +209,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### hub - + Return the experiment’s hub. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### owner - + Return the experiment’s owner. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### plot\_names - + Return names of plots associated with this experiment. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### project - + Return the experiment’s project. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### share\_level - + Return the experiment share\_level. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### start\_datetime - + Return the timestamp when the experiment started. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### uuid - + Return the experiment’s uuid. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.mdx index 6024916b50d..81a643afdf7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService # qiskit.providers.ibmq.experiment.ExperimentService - + Provides experiment related services. This class is the main interface to invoke IBM Quantum Experience experiment services, which allow you to create, delete, update, query, and retrieve experiments, experiment plots, and analysis results. The `experiment` attribute of `AccountProvider` is an instance of this class, and the main syntax for using the services is `provider.experiment.`. For example: diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.mdx index 9a592de3580..e021f5c8b76 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # qiskit.providers.ibmq.job.IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### experiment\_id - + Return the experiment ID. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index d6546e08784..b9ae5cf12e4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.mdx index 87d805c7e26..48544b087f9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index c9b26dec63c..fce3ab8622b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 498c4cdb4ee..0be7015281e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 99f7a068eca..9bc70767433 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.mdx index 68502dbe1d0..0032c174333 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # qiskit.providers.ibmq.job.QueueInfo - + Queue information for a job. QueueInfo constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 4a83b2b5e31..4e6aa4a6d8a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # qiskit.providers.ibmq.managed.IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 41ca953ad70..fdb47a8d2d7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 5b170c76193..d323f161758 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 301a390f1b5..ac9e2ec1040 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 466003a994f..84fc41df698 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 9c8e315f4d8..dbde7e33260 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 5f8bc152236..34bb745db80 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.mdx index f4b73c932ec..f780e85aacf 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # qiskit.providers.ibmq.managed.ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index e80b2ca446c..b93af0410ef 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # qiskit.providers.ibmq.managed.ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.mdx index d9365d80343..edf98ef5417 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # qiskit.providers.ibmq.managed.ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.mdx index eedfe423ce1..6b75a11390a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # qiskit.providers.ibmq.random.CQCExtractor - + Class for interfacing with a CQC remote extractor. There are two extractor methods - Dodis (extractor 1) and Hayashi (extractor 2). These methods can be invoked synchronously or asynchronously. To invoke them synchronously: diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index 80ea1efc909..16947d44465 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # qiskit.providers.ibmq.random.CQCExtractorJob - + Representation of an asynchronous call to the CQC extractor. An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### extractor\_method - + Return the extractor method used. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### parameters - + Return the parameters passed to the extractor. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.mdx index a8f677fb038..481ef7dc943 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # qiskit.providers.ibmq.random.IBMQRandomService - + Random number services for an IBM Quantum Experience account provider. Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 34c765676b8..da07ee4a081 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # qiskit.providers.ibmq.runtime.IBMRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index aaec87af4a5..b7c7236fead 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # qiskit.providers.ibmq.runtime.ProgramBackend - + Base class for a program backend. This is a [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method. @@ -127,7 +127,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index ee6ac792a14..88e4ff7c234 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # qiskit.providers.ibmq.runtime.ResultDecoder - + Runtime job result decoder. You can subclass this class and overwrite the [`decode()`](#qiskit.providers.ibmq.runtime.ResultDecoder.decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") method to create a custom result decoder for the results of your runtime program. For example: @@ -39,7 +39,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 621d98b50cc..528b9ccdbbb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # qiskit.providers.ibmq.runtime.RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`IBMRuntimeService.run`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") to execute a runtime program, or [`IBMRuntimeService.job`](qiskit.providers.ibmq.runtime.IBMRuntimeService#job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") to retrieve a previously executed job. @@ -124,7 +124,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### creation\_date - + Job creation date in local time. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### inputs - + Job input parameters. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### program\_id - + Program ID. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index e0f150c5ed6..cd6adae5b2c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # qiskit.providers.ibmq.runtime.RuntimeProgram - + Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### backend\_requirements - + Backend requirements. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### creation\_date - + Program creation date. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### description - + Program description. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### interim\_results - + Program interim result definitions. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### max\_execution\_time - + Maximum execution time in seconds. A program execution exceeding this time will be forcibly terminated. @@ -158,7 +158,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### name - + Program name. **Return type** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### parameters - + Program parameter definitions. **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### program\_id - + Program ID. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### return\_values - + Program return value definitions. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### version - + Program version. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 9cb9bdd19cf..f3537a6c31a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # qiskit.providers.ibmq.runtime.UserMessenger - + Base class for handling communication with program users. This class can be used when writing a new Qiskit Runtime program. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.mdx index 835c69bffe8..3966f38ccc8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # qiskit.providers.models.BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -171,7 +171,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.mdx index 19831bd1248..4ac5e58fa39 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # qiskit.providers.models.BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.mdx index 7ee84f27f2e..cfa0d4bcb58 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # qiskit.providers.models.BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.Command.mdx index f271532881b..09339522c2e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # qiskit.providers.models.Command - + Class representing a Command. ### name @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.mdx index 6328f6e2f8a..9cadfb03502 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # qiskit.providers.models.GateConfig - + Class representing a Gate Configuration ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.mdx index ff641da23ac..4eef33439cc 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # qiskit.providers.models.JobStatus - + Model for JobStatus. ### job\_id @@ -57,7 +57,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.mdx index 464ead889fa..201d8389a00 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # qiskit.providers.models.PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -222,7 +222,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. @@ -302,7 +302,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### sample\_rate - + Sample rate of the signal channels in Hz (1/dt). **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.mdx index 3f73d57c7ff..1ce944c27fd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # qiskit.providers.models.PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_est: `List`\[`float`] :param qubit\_freq\_est: Estimated qubit frequencies in GHz. :type meas\_freq\_est: `List`\[`float`] :param meas\_freq\_est: Estimated measurement cavity frequencies in GHz. :type buffer: `int` :param buffer: Default buffer time (in units of dt) between pulses. :type pulse\_library: `List`\[`PulseLibraryItem`] :param pulse\_library: Pulse name and sample definitions. :type cmd\_def: `List`\[`Command`] :param cmd\_def: Operation name and definition in terms of Commands. :type meas\_kernel: `Optional`\[`MeasurementKernel`] :param meas\_kernel: The measurement kernels :type discriminator: `Optional`\[`Discriminator`] :param discriminator: The discriminators :param \*\*kwargs: Other attributes for the super class. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.mdx index 5eb5950711a..df737732e9e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # qiskit.providers.models.QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -237,7 +237,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.mdx index bd425b6f965..be49880ae93 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # qiskit.providers.models.UchannelLO - + Class representing a U Channel LO ### q @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.mdx index 04c467487a0..de9e397a36c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # qiskit.pulse.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.mdx index e8849c39357..c1ba243408b 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # qiskit.pulse.AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Call.mdx index c301aa87d8a..a21446bd64c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # qiskit.pulse.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Constant.mdx index 98d9088c783..99040f927d4 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # qiskit.pulse.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.mdx index be438ad48cc..eb35cf8a9bd 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # qiskit.pulse.ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.ControlChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.ControlChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.ControlChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Delay.mdx index 4ba9ee473c3..aa4746f0f2f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # qiskit.pulse.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Drag.mdx index 174790576a5..a7c91e4f7c9 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # qiskit.pulse.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.mdx index c8966755f80..51d1d84cd36 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # qiskit.pulse.DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.DriveChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.DriveChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.DriveChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.mdx index 4961ba06abb..eff0e640dcd 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # qiskit.pulse.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.mdx index 6842ecdee91..bc3d3c43b1e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # qiskit.pulse.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.mdx index dbb0c789ab0..2b54880946e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # qiskit.pulse.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.mdx index d58be50ce63..9b96447fb6f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: 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: ```python @@ -155,7 +155,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap ### instructions - + Return all instructions which have definitions. By default, these are typically the basis gates along with other instructions such as measure and reset. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.mdx index d0845b04c06..697c9f789f3 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # qiskit.pulse.MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.mdx index 0d50a138f42..e113a86c2ad 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # qiskit.pulse.MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MemorySlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MemorySlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MemorySlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Play.mdx index 70aac063699..765ff73c74e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # qiskit.pulse.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.26/qiskit.pulse.PulseError.mdx index fb3138e4440..66e757720f6 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.mdx index f1f6b07fd9b..00735c5b621 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # qiskit.pulse.RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.mdx index 81b5b6f5204..2e66e3220b4 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # qiskit.pulse.Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Pulse program representation for the original Qiskit Pulse model \[1]. Instructions are not allowed to overlap in time on the same channel. This overlap constraint is immediately evaluated when a new instruction is added to the `Schedule` object. @@ -198,7 +198,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -280,7 +280,7 @@ $$ ### duration - + Duration of this schedule. **Return type** @@ -381,7 +381,7 @@ $$ ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -401,7 +401,7 @@ $$ ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -413,7 +413,7 @@ $$ ### name - + Name of this Schedule **Return type** @@ -423,7 +423,7 @@ $$ ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -508,7 +508,7 @@ $$ ### start\_time - + Starting time of this schedule. **Return type** @@ -518,7 +518,7 @@ $$ ### stop\_time - + Stopping time of this schedule. **Return type** @@ -528,7 +528,7 @@ $$ ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.mdx index 7f7e8d818fd..27de9bbd485 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # qiskit.pulse.ScheduleBlock - + A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. `ScheduleBlock` s should be initialized with one of the following alignment contexts: @@ -121,7 +121,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### alignment\_context - + Return alignment instance that allocates block component to generate schedule. @@ -212,7 +212,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### channels - + Returns channels that this schedule clock uses. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### duration - + Duration of this schedule block. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -435,7 +435,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -447,7 +447,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### name - + Name of this Schedule **Return type** @@ -457,7 +457,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -507,7 +507,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### start\_time - + Starting time of this schedule block. **Return type** @@ -517,7 +517,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### stop\_time - + Stopping time of this schedule block. **Return type** @@ -527,7 +527,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.mdx index 5eb564a59c4..500244af041 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # qiskit.pulse.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.mdx index c6f37e0bb03..0486fd77125 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # qiskit.pulse.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.mdx index bc377ab9bd0..6ff1db22a6e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # qiskit.pulse.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.mdx index ddae5dbc5de..9c40b64e207 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # qiskit.pulse.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.mdx index bd6ca6ac928..6a91d1d2082 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # qiskit.pulse.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.26/qiskit.pulse.Waveform.mdx index 770451a88cc..d6c14cb7d96 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # qiskit.pulse.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.26/qiskit.pulse.channels.mdx index e0b5f43be86..a87854aa1a6 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.channels.mdx @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -68,7 +68,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -88,7 +88,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -98,7 +98,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -109,7 +109,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -147,7 +147,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -167,7 +167,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -177,7 +177,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -194,7 +194,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -228,7 +228,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -248,7 +248,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -258,7 +258,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -269,7 +269,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -303,7 +303,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -323,7 +323,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -333,7 +333,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -344,7 +344,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -378,7 +378,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -398,7 +398,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -408,7 +408,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -419,7 +419,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -453,7 +453,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -473,7 +473,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -483,7 +483,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -494,7 +494,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -528,7 +528,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -548,7 +548,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -558,7 +558,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -569,7 +569,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -603,7 +603,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -623,7 +623,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -633,7 +633,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -644,7 +644,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify instructions for simulators. Create new snapshot channel. @@ -674,7 +674,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -694,7 +694,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -704,7 +704,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.mdx index af9f8dbb6a9..660d4e1ef23 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # qiskit.pulse.instructions.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.mdx index 6a3c37b217d..608894d76fe 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # qiskit.pulse.instructions.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.instructions.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.instructions.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.instructions.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.instructions.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.instructions.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.instructions.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.instructions.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.instructions.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.mdx index 8369b86de1d..56efceb15af 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # qiskit.pulse.instructions.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.mdx index 3f66630c539..89245bafc8e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # qiskit.pulse.instructions.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.mdx index 68536f999f7..c2dacd0a149 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # qiskit.pulse.instructions.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.mdx index 302bc37ba37..b084a04889d 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # qiskit.pulse.instructions.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.mdx index 93cf1ad2699..5cf2ae154e0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # qiskit.pulse.instructions.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.mdx index 5a8930f2920..1dabcd5fed6 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # qiskit.pulse.instructions.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.mdx index f0221bed8b8..1fa264f637f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # qiskit.pulse.instructions.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.mdx index dc7b7ff5b4e..352a9384892 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # qiskit.pulse.instructions.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.mdx index 7eb62e78e52..6233339c1e7 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # qiskit.pulse.library.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.mdx index a51fe226b4f..46679e23f40 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # qiskit.pulse.library.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.mdx index dda44ccfc77..3101aaa187a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # qiskit.pulse.library.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.mdx index d18de5bda5e..b4c75c6bfaf 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # qiskit.pulse.library.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.mdx index 2d79eee73c6..539f80531ef 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # qiskit.pulse.library.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.library.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.library.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.library.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.mdx index 608593533b7..ca41aa3b3a8 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # qiskit.qasm.OpenQASMLexer - + A pygments lexer for OpenQasm. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.26/qiskit.qasm.Qasm.mdx index 70d410e9d98..63643e69578 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.26/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # qiskit.qasm.Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.26/qiskit.qasm.QasmError.mdx index 14cd87fd355..6f66c674dd7 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.mdx index d237f6cc831..3bfc1bb74cd 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # qiskit.qasm.QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.mdx index 1a4ba1855b3..c934e1e9a97 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # qiskit.qasm.QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.mdx index 92e3b6ecd21..2080aa686db 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # qiskit.qobj.GateCalibration - + Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. Initialize a single gate calibration. Instructions may reference waveforms which should be made available in the pulse\_library. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.mdx index a16243a4252..00271820301 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # qiskit.qobj.PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.mdx index 64ff513dfab..7db8fd837ed 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # qiskit.qobj.PulseQobj - + A Pulse Qobj. Instantiate a new Pulse Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.mdx index e89d9636d04..046832aa29f 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # qiskit.qobj.PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.mdx index 74b0437befc..397d7c6b08f 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # qiskit.qobj.PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.mdx index f9f59971220..a322a985846 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # qiskit.qobj.PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.mdx index 033ce00ecff..e2a4d3161a6 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # qiskit.qobj.PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -69,7 +69,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.mdx index 9c1676d51e0..950978a2122 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # qiskit.qobj.QasmExperimentCalibrations - + A container for any calibrations data. The gates attribute contains a list of GateCalibrations. Initialize a container for calibrations. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.mdx index 7eda1eb6859..c9a1b870632 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # qiskit.qobj.QasmQobj - + A QASM Qobj. Instantiate a new QASM Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.mdx index 591875f1890..34ee1f024be 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # qiskit.qobj.QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.mdx index a5471ffae90..8fd80a224c6 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # qiskit.qobj.QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.mdx index f0fdc45a153..81c2439bc39 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # qiskit.qobj.QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.mdx index 1c7452d3042..c7263876019 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # qiskit.qobj.QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instantiate a new QasmQobjInstruction object. @@ -59,7 +59,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.26/qiskit.qobj.Qobj.mdx index 2168992b323..45efedcd247 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # qiskit.qobj.Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.mdx index a2f87d48f39..53b1a30cd5d 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # qiskit.qobj.QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.mdx index 1ca7a1fdafb..be9f79fb536 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # qiskit.qobj.QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.mdx index 1e53087d0c8..ed169601163 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # qiskit.qobj.QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.mdx index 32369bab1cc..964f8c55e08 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # qiskit.quantum\_info.CNOTDihedral - + An N-qubit operator from the CNOT-Dihedral group. > The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -216,7 +216,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.mdx index e5b0d1fe285..9199d2d2966 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # qiskit.quantum\_info.Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.mdx index 922747afa95..ac260b1ee2d 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # qiskit.quantum\_info.Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.mdx index a1b491e0259..a29ae1c1cff 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # qiskit.quantum\_info.Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -158,13 +158,13 @@ python_api_name: qiskit.quantum_info.Clifford ### destabilizer - + Return the destabilizer block of the StabilizerTable. ### dim - + Return tuple (input\_shape, output\_shape). @@ -209,7 +209,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -231,13 +231,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -297,7 +297,7 @@ python_api_name: qiskit.quantum_info.Clifford ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -331,7 +331,7 @@ python_api_name: qiskit.quantum_info.Clifford ### qargs - + Return the qargs for the operator. @@ -361,13 +361,13 @@ python_api_name: qiskit.quantum_info.Clifford ### stabilizer - + Return the stabilizer block of the StabilizerTable. ### table - + Return StabilizerTable diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.mdx index 6e5dd41cf01..e4ee2bb649a 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # qiskit.quantum\_info.DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### data - + Return data. ### dim - + Return total state dimension. @@ -227,7 +227,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -277,7 +277,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -336,7 +336,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -480,7 +480,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.mdx index 782285ef5f9..1b347a34c1d 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # qiskit.quantum\_info.Kraus - + Kraus representation of a quantum channel. For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -112,7 +112,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -164,13 +164,13 @@ $$ ### data - + Return list of Kraus matrices for channel. ### dim - + Return tuple (input\_shape, output\_shape). @@ -245,7 +245,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -283,7 +283,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -313,7 +313,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 67fe93c0e6c..8bf5627f545 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # qiskit.quantum\_info.OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ Euler parameters are used. @@ -106,7 +106,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer ### basis - + The decomposition basis. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.mdx index 8d9c60b9fe6..b8aacd8dad4 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # qiskit.quantum\_info.Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -102,7 +102,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -150,13 +150,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -221,7 +221,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -259,7 +259,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -293,7 +293,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -339,7 +339,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.mdx index dee7440785f..53925f8bb91 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # qiskit.quantum\_info.PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.mdx index c89c32f8516..615234b1ef9 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # qiskit.quantum\_info.Pauli - + N-qubit Pauli operator. This class represents an operator $P$ from the full $n$-qubit *Pauli* group @@ -318,7 +318,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -407,7 +407,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -521,7 +521,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -533,7 +533,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -553,7 +553,7 @@ $$ ### phase - + Return the group phase exponent for the Pauli. @@ -581,13 +581,13 @@ $$ ### qargs - + Return the qargs for the operator. ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -632,7 +632,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -646,7 +646,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](#qiskit.quantum_info.Pauli.compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](#qiskit.quantum_info.Pauli.dot "qiskit.quantum_info.Pauli.dot"). @@ -807,13 +807,13 @@ $$ ### x - + The x vector for the Pauli. ### z - + The z vector for the Pauli. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.mdx index 7db41eba4b1..117f5f09a39 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # qiskit.quantum\_info.PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -142,13 +142,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). @@ -200,7 +200,7 @@ $$ ### array - + The underlying boolean array. @@ -327,7 +327,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -410,7 +410,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -501,7 +501,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -535,7 +535,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -565,13 +565,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.mdx index a5a97ea9722..599df402489 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # qiskit.quantum\_info.Quaternion - + A class representing a Quaternion. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.mdx index 44802a1fa84..1161803daac 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # qiskit.quantum\_info.ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -79,13 +79,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeff - + Return the coefficient @@ -133,7 +133,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,7 +190,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -220,7 +220,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### qargs - + Return the qargs for the operator. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.mdx index e9bb387e501..43219c97c67 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # qiskit.quantum\_info.SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -91,13 +91,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeffs - + Return the Pauli coefficients. @@ -145,7 +145,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,13 +190,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -283,7 +283,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -317,7 +317,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### qargs - + Return the qargs for the operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### rtol - + Default relative tolerance parameter for float comparisons. @@ -372,13 +372,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### size - + The number of Pauli of Pauli terms in the operator. ### table - + Return the the PauliTable. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.mdx index 122d64a026c..dbfe4924b86 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # qiskit.quantum\_info.StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -156,13 +156,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). @@ -216,7 +216,7 @@ $$ ### array - + The underlying boolean array. @@ -354,7 +354,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -446,7 +446,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -549,7 +549,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -561,13 +561,13 @@ $$ ### pauli - + Return PauliTable ### phase - + Return phase vector @@ -595,7 +595,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -625,13 +625,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.mdx index 07210dd6300..5d29189579b 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # qiskit.quantum\_info.Statevector - + Statevector class Initialize a statevector object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.Statevector ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.Statevector ### data - + Return data. ### dim - + Return total state dimension. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -275,7 +275,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -360,7 +360,7 @@ python_api_name: qiskit.quantum_info.Statevector ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -504,7 +504,7 @@ python_api_name: qiskit.quantum_info.Statevector ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.mdx index 10c726b40f5..725541e1e14 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # qiskit.quantum\_info.Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -114,7 +114,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -166,13 +166,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -247,7 +247,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -285,7 +285,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -315,7 +315,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.mdx index 04338e9cf8e..91a65b95a30 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # qiskit.quantum\_info.SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 585d2b7b061..df78f8c51e5 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # qiskit.quantum\_info.TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.26/qiskit.result.Counts.mdx b/docs/api/qiskit/0.26/qiskit.result.Counts.mdx index 5831bf958c9..dfc594b5039 100644 --- a/docs/api/qiskit/0.26/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.26/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # qiskit.result.Counts - + A class to store a counts result from a circuit execution. Build a counts object diff --git a/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.mdx index 9087f8a6e0e..aa271844d8b 100644 --- a/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # qiskit.result.ProbDistribution - + A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.mdx index 89c87e3e078..84a406f4ceb 100644 --- a/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # qiskit.result.QuasiDistribution - + A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.26/qiskit.result.Result.mdx b/docs/api/qiskit/0.26/qiskit.result.Result.mdx index d44379b7084..e6d211777b0 100644 --- a/docs/api/qiskit/0.26/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.26/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # qiskit.result.Result - + Model for Results. ### backend\_name @@ -124,7 +124,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.26/qiskit.result.ResultError.mdx index e250fb23a88..0fd70dbb09b 100644 --- a/docs/api/qiskit/0.26/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.26/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.mdx index ab85076a420..4128437aeeb 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # qiskit.scheduler.ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.mdx index 27d9febaa5d..81451cc6f50 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # qiskit.transpiler.AnalysisPass - + An analysis pass: change property set, not DAG. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.mdx index f3513b34883..1f57c22118a 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # qiskit.transpiler.CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### distance\_matrix - + Return the distance matrix for the coupling map. @@ -133,25 +133,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### is\_symmetric - + Test if the graph is symmetric. Return True if symmetric, False otherwise @@ -207,7 +207,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### physical\_qubits - + Returns a sorted list of physical\_qubits diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.mdx index 246e3c2b753..143c7f14c71 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # qiskit.transpiler.FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.mdx index 5402b16609b..192aa4b068e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # qiskit.transpiler.FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.mdx index 54a1f8f3805..26dcb48f808 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # qiskit.transpiler.FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.mdx index 4a2329edcfb..8c31bda65f1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # qiskit.transpiler.InstructionDurations - + Helper class to provide durations of instructions for scheduling. It stores durations (gate lengths) and dt to be used at the scheduling stage of transpiling. It can be constructed from `backend` or `instruction_durations`, which is an argument of `transpile()`. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.Layout.mdx index d3a9aa839fa..021d615fdc6 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # qiskit.transpiler.Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -135,7 +135,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.mdx index d4d660772d1..c0d1088947b 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # qiskit.transpiler.PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.mdx index 230818965be..c6bd129c327 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # qiskit.transpiler.PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.mdx index a3115e25f10..61334a1ff05 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # qiskit.transpiler.PropertySet - + A default dictionary-like object ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.mdx index ac664e71627..2b453ee2c63 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # qiskit.transpiler.TransformationPass - + A transformation pass: change DAG, not property set. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.mdx index 2ec9052b1b9..ea4d333a912 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.mdx index a97f0a76b52..78f17c62b2e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.mdx index dad51e462f2..56892c05a47 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # qiskit.transpiler.passes.ALAPSchedule - + ALAP Scheduling. ALAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.mdx index e99b9ec0bbf..1a08de4dec9 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # qiskit.transpiler.passes.ASAPSchedule - + ASAP Scheduling. ASAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.mdx index b620fafa85d..9c9acce6352 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # qiskit.transpiler.passes.ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 15919b00dfc..bf49e66d4b1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # qiskit.transpiler.passes.BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.mdx index f38dc741ff3..02dd5d86ccc 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # qiskit.transpiler.passes.BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.mdx index 2b63c4cf378..3d642698549 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # qiskit.transpiler.passes.BasisTranslator - + Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. This pass operates in several steps: @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.mdx index 7503e8a4690..b9e24361d31 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # qiskit.transpiler.passes.CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.mdx index 9fd094457b2..f0b70609883 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # qiskit.transpiler.passes.CXCancellation - + Cancel back-to-back cx gates in dag. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.mdx index 34c871833d3..2d271a2bff4 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # qiskit.transpiler.passes.CXDirection - + Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. GateDirection pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.mdx index e667de9216d..a9b9918cb9b 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # qiskit.transpiler.passes.CheckCXDirection - + Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.mdx index f6510901f47..1ccb478b0f8 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # qiskit.transpiler.passes.CheckGateDirection - + Check if the two-qubit gates follow the right direction with respect to the coupling map. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.mdx index d6377cd2b8d..4bf3ed3ade9 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # qiskit.transpiler.passes.CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.mdx index 38255168c0e..5d39dd2bf04 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # qiskit.transpiler.passes.Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to property\_set as a dictionary of the form: @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.mdx index 9ef9b0d91df..244d8076fc5 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # qiskit.transpiler.passes.CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.mdx index fe5e7136155..75a0384281c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # qiskit.transpiler.passes.CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 43236b08928..3d3d468d1a4 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # qiskit.transpiler.passes.ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.mdx index 9408bb28f04..6bf971c0bae 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # qiskit.transpiler.passes.CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.mdx index acde255c6dd..41e9e46899f 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # qiskit.transpiler.passes.CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index e81aa1e1f2e..b6e2e15a0ac 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # qiskit.transpiler.passes.CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. @@ -216,7 +216,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -230,7 +230,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.mdx index d7439329702..80690c14816 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # qiskit.transpiler.passes.DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.mdx index 243679d198b..08f525f0379 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # qiskit.transpiler.passes.DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.mdx index cb71701d9b4..985084c6131 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # qiskit.transpiler.passes.Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.mdx index 3b877f5d3cf..00644d786ac 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # qiskit.transpiler.passes.DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.mdx index 1407152212d..a8ed13af4eb 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # qiskit.transpiler.passes.Depth - + Calculate the depth of a DAG circuit. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e32e846b624..9a5cdfa7d81 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # qiskit.transpiler.passes.EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.mdx index 9d83ac7e79b..fdba1fade22 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # qiskit.transpiler.passes.FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 035d7b87fb8..8b34c584905 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # qiskit.transpiler.passes.FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.mdx index 1de86ce793b..36648a24aef 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # qiskit.transpiler.passes.GateDirection - + Modify asymmetric gates to match the hardware coupling direction. This pass makes use of the following identities: @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.mdx index b453a21a63d..755fd759005 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # qiskit.transpiler.passes.Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.mdx index dd4c07bfe2c..c28e00b7e0d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # qiskit.transpiler.passes.LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 1efdb3e8659..527fe9f42e2 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # qiskit.transpiler.passes.MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 0fe1486f40a..e8f2223c7b0 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # qiskit.transpiler.passes.NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.mdx index d1b67c0a487..2c1222ddf99 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # qiskit.transpiler.passes.NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.mdx index 9b24675e825..767990f30bd 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # qiskit.transpiler.passes.Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index ae009c4f21e..4856eab18db 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # qiskit.transpiler.passes.Optimize1qGatesDecomposition - + Optimize chains of single-qubit gates by combining them into a single gate. Optimize1qGatesDecomposition initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 46ea4bf5823..af8e1246a1d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # qiskit.transpiler.passes.RZXCalibrationBuilder - + Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). Initializes a RZXGate calibration builder. @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -84,7 +84,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 05ecc6af7c5..b709e0df4cc 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 8675f915984..544b2c169a9 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # qiskit.transpiler.passes.RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 1d330a94c68..30e2e8cb627 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # qiskit.transpiler.passes.RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.mdx index 96b47bc92b3..482686be9a1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # qiskit.transpiler.passes.SabreLayout - + Choose a Layout via iterative bidirectional routing of the input circuit. Starting with a random initial Layout, the algorithm does a full routing of the circuit (via the routing\_pass method) to end up with a final\_layout. This final\_layout is then used as the initial\_layout for routing the reverse circuit. The algorithm iterates a number of times until it finds an initial\_layout that reduces full routing cost. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.mdx index 2c4048bb9e5..2e1ea7666fd 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # qiskit.transpiler.passes.SabreSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of the SWAP-based heuristic search from the SABRE qubit mapping paper \[1] (Algorithm 1). The heuristic aims to minimize the number of lossy SWAPs inserted and the depth of the circuit. @@ -124,7 +124,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -132,7 +132,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.mdx index 4f07c35e469..c129fa18359 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # qiskit.transpiler.passes.SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.mdx index 1cc78e62958..9724f37f99e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # qiskit.transpiler.passes.Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.mdx index fa0c8d61405..60dbbf22504 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # qiskit.transpiler.passes.StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.mdx index ee9a49ac213..4ac6d9921c4 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # qiskit.transpiler.passes.TemplateOptimization - + Class for the template optimization pass. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.mdx index 446a5bdd47a..7d7b18a389c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # qiskit.transpiler.passes.TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.mdx index 9f9436bd943..300a570ad78 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # qiskit.transpiler.passes.UnitarySynthesis - + Synthesize gates according to their basis gates. Synthesize unitaries over some basis gates. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f3ef3c0cc34..8f3901e44a2 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # qiskit.transpiler.passes.Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 4db4a49e651..e48b1b53bc6 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # qiskit.transpiler.passes.UnrollCustomDefinitions - + Unrolls instructions with custom definitions. Unrolls instructions with custom definitions. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.mdx index 8080d5ce674..76547951fcb 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # qiskit.transpiler.passes.Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.mdx index 7b5f85bb346..81f5ce6b7cb 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # qiskit.transpiler.passes.Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.mdx index dbb7bf7d1c5..2133ce1dd4f 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # qiskit.utils.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.utils.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.utils.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.utils.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.utils.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.utils.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.utils.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.mdx index ecb289e5ad6..daa77f3d557 100644 --- a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.mdx index 335265d4046..34e2e716b0d 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 054aacd5461..19e5fff1228 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # qiskit.visualization.pulse\_v2.IQXDebugging - + Pulse stylesheet for pulse programmers. Show details of instructions. \# TODO: add more generators diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.mdx index a04d7e247b5..efea44d0361 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # qiskit.visualization.pulse\_v2.IQXSimple - + Simple pulse stylesheet without channel notation. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.mdx index 9255beb4f13..6601a544500 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # qiskit.visualization.pulse\_v2.IQXStandard - + Standard pulse stylesheet. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.mdx index bb00e78d3b3..43aeb361123 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # qiskit.visualization.qcstyle.DefaultStyle - + Creates a Default Style dictionary **Style Dict Details** diff --git a/docs/api/qiskit/0.27/logging.mdx b/docs/api/qiskit/0.27/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.27/logging.mdx +++ b/docs/api/qiskit/0.27/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.mdx index ced373b54da..7a1fd62186e 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.mdx index 9990867277d..74a6cdcbed6 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # qiskit.algorithms.AmplificationProblem - + The amplification problem is the input to amplitude amplification algorithms, like Grover. This class contains all problem-specific information required to run an amplitude amplification algorithm. It minimally contains the Grover operator. It can further hold some post processing on the optimal bitstring. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### is\_good\_state - + Check whether a provided bitstring is a good state or not. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### objective\_qubits - + The indices of the objective qubits. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### oracle - + Return the oracle. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### state\_preparation - + Get the state preparation operator $\mathcal{A}$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.mdx index aeb2d42d7f1..9d372e77ff6 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # qiskit.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -76,7 +76,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -101,7 +101,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** @@ -184,7 +184,7 @@ $$ ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.mdx index 831d8c595ce..61150b6a242 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # qiskit.algorithms.AmplitudeEstimationResult - + The `AmplitudeEstimation` result object. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### measurements - + Return the measurements as integers with their measurement probability. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle - + Return the MLE for the amplitude, in $\[0, 1]\$. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle\_processed - + Return the post-processed MLE for the amplitude. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_evaluation\_qubits - + Returns the number of evaluation qubits. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples - + Return the measurement samples with their measurement probability. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples\_processed - + Return the post-processed measurement samples with their measurement probability. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.mdx index 41de4a7b71b..f590f52119e 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # qiskit.algorithms.AmplitudeEstimator - + The Amplitude Estimation interface. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.mdx index c79948487f1..b4ca7246bcf 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # qiskit.algorithms.AmplitudeEstimatorResult - + The results object for amplitude estimation algorithms. ### \_\_init\_\_ @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.mdx index 75703feaa0d..97591d96c87 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # qiskit.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.mdx index 3c4d59fed31..6c46a5663d3 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # qiskit.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.mdx index a5fdcba53b2..bbf8f361d15 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # qiskit.algorithms.EstimationProblem - + The estimation problem is the input to amplitude estimation algorithm. This class contains all problem-specific information required to run an amplitude estimation algorithm. That means, it minimally contains the state preparation and the specification of the good state. It can further hold some post processing on the estimation of the amplitude or a custom Grover operator. @@ -52,7 +52,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### is\_good\_state - + Checks whether a bitstring represents a good state. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 9c20bee8a2c..38c3a309ade 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # qiskit.algorithms.FasterAmplitudeEstimation - + The Faster Amplitude Estimation algorithm. The Faster Amplitude Estimation (FAE) \[1] algorithm is a variant of Quantum Amplitude Estimation (QAE), where the Quantum Phase Estimation (QPE) by an iterative Grover search, similar to \[2]. @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index ba826fed8cc..6aa96221f17 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # qiskit.algorithms.FasterAmplitudeEstimationResult - + The result object for the Faster Amplitude Estimation algorithm. ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_first\_state\_steps - + Return the number of steps taken in the first step of algorithm. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_steps - + Return the total number of steps taken in the algorithm. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### success\_probability - + Return the success probability of the algorithm. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.Grover.mdx index 593a96614a0..8cb46d4ecb7 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # qiskit.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -159,7 +159,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -178,7 +178,7 @@ $$ ### quantum\_instance - + Get the quantum instance. :rtype: `Optional`\[`QuantumInstance`] :returns: The quantum instance used to run this algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.mdx index 30550458714..f2db1318e6d 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # qiskit.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.GroverResult ### assignment - + The post-processed value of the most likely bitstring. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.GroverResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.GroverResult ### iterations - + All the powers of the Grover operator that have been tried. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.GroverResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.GroverResult ### oracle\_evaluation - + Whether the classical oracle evaluation of the top measurement was True or False. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.GroverResult ### top\_measurement - + The most frequently measured output as bitstring. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.HHL.mdx index 7689364f83d..4e891d60b79 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # qiskit.algorithms.HHL - + 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. A system of linear equations is called $s$-sparse if $A$ has at most $s$ non-zero entries per row or column. Solving an $s$-sparse system of size $N$ with a classical computer requires $\mathcal{ O }(Ns\kappa\log(1/\epsilon))$ running time using the conjugate gradient method. Here $\kappa$ denotes the condition number of the system and $\epsilon$ the accuracy of the approximation. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.HHL ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.HHL ### quantum\_instance - + Get the quantum instance. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.HHL ### scaling - + The scaling of the solution vector. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index ade2cd90c7e..bfbb740e847 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # qiskit.algorithms.HamiltonianPhaseEstimation - + Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index f416f931b6e..61cb6ff02df 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # qiskit.algorithms.HamiltonianPhaseEstimationResult - + Store and manipulate results from running HamiltonianPhaseEstimation. This API of this class is nearly the same as PhaseEstimatorResult, differing only in the presence of an additional keyword argument in the methods. If scaled is False, then the phases are not translated and scaled to recover the eigenvalues of the Hamiltonian. Instead phi in $[0, 1)$ is returned, as is the case when then unitary is not derived from a Hamiltonian. @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_eigenvalue - + The most likely eigenvalue of the Hamiltonian. This method calls most\_likely\_phase and scales the result to obtain an eigenvalue. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_phase - + The most likely phase of the unitary corresponding to the Hamiltonian. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 3fbcbcf4b92..4891df7181a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # qiskit.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### epsilon\_target - + Returns the target precision `epsilon_target` of the algorithm. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 385c82d1cc9..28a433a2dc1 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # qiskit.algorithms.IterativeAmplitudeEstimationResult - + The `IterativeAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### alpha - + Return the confidence level $\alpha$. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated - + Return the estimated half-width of the confidence interval. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated\_processed - + Return the post-processed estimated half-width of the confidence interval. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_target - + Return the target half-width of the confidence interval. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimate\_intervals - + Return the confidence intervals for the estimate in each iteration. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### powers - + Return the powers of the Grover operator in each iteration. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### ratios - + Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.mdx index d8a1825a82f..7aef2efe41f 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # qiskit.algorithms.LinearSolver - + An abstract class for linear system solvers in Qiskit. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.mdx index da53deb9a45..f8028c4f5bc 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # qiskit.algorithms.LinearSolverResult - + A base class for linear systems results. The linear systems algorithms return an object of the type `LinearSystemsResult` with the information about the solution obtained. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### circuit\_results - + return the results from the circuits **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### euclidean\_norm - + return the euclidean norm if the algorithm knows how to calculate it **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### observable - + return the (list of) calculated observable(s) **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### state - + return either the circuit that prepares the solution or the solution as a vector **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index ddf76b3e13c..5f4bf8428f4 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -65,7 +65,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 0184cc3fc4d..685be864272 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + The `MaximumLikelihoodAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### evaluation\_schedule - + Return the evaluation schedule for the powers of the Grover operator. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### fisher\_information - + Return the Fisher information for the estimated amplitude. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### good\_counts - + Return the percentage of good counts per circuit power. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### minimizer - + Return the minimizer used for the search of the likelihood function. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### theta - + Return the estimate for the angle $\theta$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.mdx index f1edaaf58a1..c1e062c5420 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # qiskit.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.mdx index 228b97dc194..7e28b33e762 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # qiskit.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.mdx index 90fe56f19ab..97b777300bb 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # qiskit.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.mdx index cd454456bf9..ddbb4aa2e80 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # qiskit.algorithms.NumPyLinearSolver - + The Numpy Linear Solver algorithm (classical). This linear system solver computes the exact value of the given observable(s) or the full solution vector if no observable is specified. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 56110e2bd3d..e865a35ee25 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # qiskit.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.mdx index ecb1c5edeec..25d440c5e1c 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # qiskit.algorithms.PhaseEstimation - + Run the Quantum Phase Estimation (QPE) algorithm. This runs QPE with a multi-qubit register for reading the phases \[1] of input states. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.mdx index 84e91d4e94b..ae3df3f0dc6 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # qiskit.algorithms.PhaseEstimationResult - + Store and manipulate results from running PhaseEstimation. This class is instantiated by the PhaseEstimation class, not via user code. The PhaseEstimation class generates a list of phases and corresponding weights. Upon completion it returns the results as an instance of this class. The main method for accessing the results is filter\_phases. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### circuit\_result - + Return the result object returned by running the QPE circuit (on hardware or simulator). This is useful for inspecting and troubleshooting the QPE algorithm. @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### most\_likely\_phase - + Return the estimated phase as a number in $[0.0, 1.0)$. 1.0 corresponds to a phase of $2\pi$. It is assumed that the input vector is an eigenvector of the unitary so that the peak of the probability density occurs at the bit string that most closely approximates the true phase. @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### phases - + Return all phases and their frequencies computed by QPE. This is an array or dict whose values correspond to weights on bit strings. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.mdx index de8b5fe52b2..c4adc1fd63a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # qiskit.algorithms.PhaseEstimationScale - + Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. The `bound` is set when constructing this class. Then the method `scale` is used to find the factor by which to scale the operator. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### scale - + Return the Hamiltonian scaling factor. Return the scale factor by which a Hermitian operator must be multiplied so that the phase of the corresponding unitary is restricted to $[-\pi, \pi]$. This factor is computed from the bound on the absolute values of the eigenvalues of the operator. The methods `scale_phase` and `scale_phases` are used recover the eigenvalues corresponding the original (unscaled) Hermitian operator. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.mdx index afc9fdb111d..b68f4a5d4f4 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # qiskit.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.QAOA ### ansatz - + Returns the ansatz **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -314,13 +314,13 @@ python_api_name: qiskit.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.Shor.mdx index e5391b14f03..18067079485 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # qiskit.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.mdx index dd2900a81c7..28195990185 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # qiskit.algorithms.ShorResult - + Shor Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.ShorResult ### factors - + returns factors **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.ShorResult ### successful\_counts - + returns successful counts **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.ShorResult ### total\_counts - + returns total counts **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.VQE.mdx index 79f9df17a7a..b49aedeaaff 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # qiskit.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a quantum algorithm that uses a variational technique to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.VQE ### ansatz - + Returns the ansatz **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.algorithms.VQE ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.mdx index fc74e1e22c1..675814e2e5e 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # qiskit.algorithms.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.mdx index d7346c7e104..daab840bb70 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # qiskit.algorithms.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,67 +128,67 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -246,13 +246,13 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.mdx index fcb0a2f613b..964e41e9f92 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # qiskit.algorithms.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.mdx index 944643038d4..306552d8a39 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # qiskit.algorithms.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.mdx index 2fae01a4b4f..bcde425a455 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # qiskit.algorithms.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.mdx index 0c48de21807..3cd90f0363b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # qiskit.algorithms.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.mdx index c5ec1cdb5de..c51d642ba16 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # qiskit.algorithms.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 7cf901ff8a2..464d9d03db8 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # qiskit.algorithms.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.mdx index 4f7f71ce569..29ad20d828b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # qiskit.algorithms.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.mdx index 2a12f8e9418..3f40387487d 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # qiskit.algorithms.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -146,67 +146,67 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -338,13 +338,13 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.mdx index 70d5a6fd704..a8f17c14123 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # qiskit.algorithms.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.mdx index 4bcfd949f8b..eb30e1dbefe 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # qiskit.algorithms.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.mdx index e57f4129113..0085bc49ce9 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # qiskit.algorithms.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index f4f0c2c9618..cc917aa2ea2 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # qiskit.algorithms.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.mdx index c0fdb812a42..e6ac4b40930 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # qiskit.algorithms.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.mdx index 122975bb292..4022783ae9c 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # qiskit.algorithms.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 32eb1868947..fd14ed2b84b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # qiskit.algorithms.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.mdx index e43ba54fb81..664d301c356 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # qiskit.algorithms.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.mdx index 0e3cb6b9614..33547a16dd4 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # qiskit.algorithms.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.mdx index 122a5acebd2..7345f066bba 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # qiskit.algorithms.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.mdx index 448d7b75c14..f345b079737 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # qiskit.algorithms.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.mdx index 0293256115b..40414b7f195 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # qiskit.algorithms.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA \[1] is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -96,13 +96,13 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -151,7 +151,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -172,67 +172,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -286,13 +286,13 @@ $$ ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.mdx index 012053edb16..ae1dfb33859 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # qiskit.algorithms.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.27/qiskit.aqua.AquaError.mdx index cfb60f8d6da..b014309ee47 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.mdx index 537435976d9..ed6e75058c4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.mdx index 2915686d9f2..ba2584ac7ca 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # qiskit.aqua.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.aqua.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index fd56a255ecf..6a35fae521a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # qiskit.aqua.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -91,7 +91,7 @@ $$ ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -109,7 +109,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -161,7 +161,7 @@ $$ ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -177,7 +177,7 @@ $$ ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -219,7 +219,7 @@ $$ ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -251,7 +251,7 @@ $$ ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -273,7 +273,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -283,7 +283,7 @@ $$ ### random - + Return a numpy random. @@ -322,7 +322,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 5b9f724ff8a..873ab10b775 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult - + AmplitudeEstimationAlgorithm Result. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### a\_estimation - + return a\_estimation **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### estimation - + return estimation **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index de7e30b69ad..43e1456342e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # qiskit.aqua.algorithms.AmplitudeEstimationResult - + AmplitudeEstimation Result. ### \_\_init\_\_ @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_samples - + return a\_samples **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### circuit\_result - + return circuit result **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_a\_samples - + return mapped\_a\_samples **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_values - + return mapped\_values **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### max\_probability - + return max\_probability **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### ml\_value - + returns ml\_value **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mle - + return mle **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### probabilities - + return probabilities **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### shots - + return shots **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### y\_measurements - + return y\_measurements **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.mdx index ae4911c2635..44903b2aaf5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # qiskit.aqua.algorithms.BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index ba3f4257eed..80bf2b8b21c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # qiskit.aqua.algorithms.ClassicalAlgorithm - + Base class for Classical Algorithms. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index b99c7789762..fab4625a50d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # qiskit.aqua.algorithms.ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### random - + Return a numpy random. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### solution - + return solution diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.mdx index 61f63f2b650..01f87c17ba6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # qiskit.aqua.algorithms.DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.mdx index 0f903e2a1ae..045557279ff 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # qiskit.aqua.algorithms.EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.mdx index fb7faece3bf..547838264e3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # qiskit.aqua.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.mdx index 33c8bb26b35..9dfaf18e713 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # qiskit.aqua.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.mdx index 5f097a1b694..a8e75faf3b8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # qiskit.aqua.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -145,7 +145,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -174,7 +174,7 @@ $$ ### grover\_operator - + Returns grover\_operator. **Return type** @@ -202,7 +202,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -239,7 +239,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -249,7 +249,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.mdx index eff6a058332..9dcb420e0d8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # qiskit.aqua.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### assignment - + return assignment **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### circuit - + return circuit **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### measurement - + returns measurement **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### oracle\_evaluation - + return oracle evaluation **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### top\_measurement - + return top measurement **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.mdx index f7b3190b727..b4aaeccb6fe 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # qiskit.aqua.algorithms.HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -94,7 +94,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -122,7 +122,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -141,7 +141,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -160,7 +160,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** @@ -183,7 +183,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -193,7 +193,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.mdx index 3efe7dde0ae..e7382b96c50 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # qiskit.aqua.algorithms.HHLResult - + HHL Result. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### circuit\_info - + return circuit info **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### matrix - + return matrix **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### output - + return output **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### probability\_result - + return probability result **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### solution - + return solution **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### vector - + return vector **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.mdx index 959b84047b5..3dd5a16d8d2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # qiskit.aqua.algorithms.IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### random - + Return a numpy random. @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index d441266b937..85fba18f286 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # qiskit.aqua.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -166,7 +166,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -276,7 +276,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -286,7 +286,7 @@ $$ ### random - + Return a numpy random. @@ -325,7 +325,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index 5aa96c6cb2a..748d7af8f53 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult - + IterativeAmplitudeEstimation Result. ### \_\_init\_\_ @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_intervals - + return a\_intervals **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### actual\_epsilon - + return mle **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### alpha - + return alpha **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### powers - + return powers **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### ratios - + return ratios **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + return theta\_intervals **Return type** @@ -232,7 +232,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### value\_confidence\_interval - + return value\_confidence\_interval **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.mdx index fe9b12ced34..e630d32e5a5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # qiskit.aqua.algorithms.LinearsolverResult - + Linear solver Result. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 5956f87cf12..f7a68685d01 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -265,7 +265,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -275,7 +275,7 @@ $$ ### random - + Return a numpy random. @@ -314,7 +314,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 906324e009b..5b52cbed115 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + MaximumLikelihoodAmplitudeEstimation Result. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### a\_estimation - + return a\_estimation **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### circuit\_results - + return circuit results **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### confidence\_interval - + return confidence\_interval **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### estimation - + return estimation **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fisher\_information - + return fisher\_information **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### theta - + returns theta **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.mdx index b6c140be94f..8029dc3fd04 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # qiskit.aqua.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 2bde057521c..9d12d47da10 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # qiskit.aqua.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 3ef6ca0060a..e4e7dccc595 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # qiskit.aqua.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + Return the operator. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### random - + Return a numpy random. @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 4137b98fa34..ab6429e5780 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # qiskit.aqua.algorithms.NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 566acdf6ce2..2cd0965e0a8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # qiskit.aqua.algorithms.NumPyLSsolverResult - + Numpy LinearSystem Result. ### \_\_init\_\_ @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### eigvals - + return eigvals **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7d9471a3152..da3bb41909b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # qiskit.aqua.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### random - + Return a numpy random. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.mdx index 6db057482a9..9d457d3345b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # qiskit.aqua.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### random - + Return a numpy random. @@ -381,13 +381,13 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -403,7 +403,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.mdx index bde7b216d3e..a4640bfb4db 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # qiskit.aqua.algorithms.QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### d\_loss - + Returns discriminator loss **Return type** @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### discriminator - + Returns discriminator ### g\_loss - + Returns generator loss **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### generator - + Returns generator @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** @@ -154,13 +154,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### random - + Return a numpy random. ### rel\_entr - + Returns relative entropy between target and trained distribution **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### seed - + Returns random seed @@ -236,7 +236,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### tol\_rel\_ent - + Returns tolerance for relative entropy diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.mdx index 6c9e148847b..58d9d250342 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # qiskit.aqua.algorithms.QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### random - + Return a numpy random. @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.mdx index 32742d729af..26b863c939f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # qiskit.aqua.algorithms.QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### backend - + Returns backend. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** @@ -211,13 +211,13 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 8d7434818c7..8fff26c125c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # qiskit.aqua.algorithms.QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.mdx index 8a1addbcac2..aa0bdfe3ce4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # qiskit.aqua.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.mdx index 02fd7514957..52cee62018b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # qiskit.aqua.algorithms.Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.mdx index 8442c69cdc2..2b3cd189861 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # qiskit.aqua.algorithms.SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### class\_to\_label - + returns class to label ### label\_to\_class - + returns label to class @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.mdx index e407ef511ec..dd6068fd946 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # qiskit.aqua.algorithms.VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### class\_to\_label - + returns class to label @@ -161,13 +161,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### datapoints - + return data points ### feature\_map - + Return the feature map. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### label\_to\_class - + returns label to class @@ -261,13 +261,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -308,13 +308,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### random - + Return a numpy random. ### ret - + returns result @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### test\_dataset - + returns test dataset @@ -400,13 +400,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### training\_dataset - + returns training dataset ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.mdx index 5858de9ca78..3fa09a819db 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # qiskit.aqua.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -256,7 +256,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### random - + Return a numpy random. @@ -359,13 +359,13 @@ python_api_name: qiskit.aqua.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.mdx index b0b7def3bba..8f044e16bee 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # qiskit.aqua.circuits.CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.CNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.CNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.mdx index 60722895645..ed1b17ee960 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # qiskit.aqua.circuits.DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.DNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.DNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.mdx index 39accb7c113..dc04485582a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # qiskit.aqua.circuits.ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.ESOP ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.ESOP ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index fe33c11495f..a79c9488078 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # qiskit.aqua.circuits.PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### ancillary\_register - + returns ancillary register ### auxiliary\_register - + returns auxiliary register @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### state\_register - + returns state register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.mdx index c67dcb3cd56..a9d6dfe55ee 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # qiskit.aqua.circuits.StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.mdx index 5b275bb3535..263261e906a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # qiskit.aqua.circuits.WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -161,31 +161,31 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits ### num\_carry\_qubits - + returns num carry qubits ### num\_state\_qubits - + returns num state qubits ### num\_sum\_qubits - + returns num sum qubits ### num\_target\_qubits - + Returns the number of target qubits @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### weights - + returns weights diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.mdx index 570312bdb3b..c841ee04b7f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # qiskit.aqua.components.eigs.Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.mdx index 1d94727e0b7..a000ed40f95 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # qiskit.aqua.components.eigs.EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 4b489a699f9..b4939e34896 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # qiskit.aqua.components.feature\_maps.FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -58,31 +58,31 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index a9409dc9d07..4ca15fe4605 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # qiskit.aqua.components.feature\_maps.RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -69,31 +69,31 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.mdx index 6510698a98a..aff22f669fe 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # qiskit.aqua.components.initial\_states.Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.mdx index 1c371ffad98..8dcee7e91fb 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # qiskit.aqua.components.initial\_states.InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -34,11 +34,11 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### bitstr - + ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.mdx index 57a9002c711..509eca8b2e4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # qiskit.aqua.components.initial\_states.VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.mdx index b51ef7cc33e..cd6b622ed1f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # qiskit.aqua.components.initial\_states.Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 23d339ab751..a6cc6497dc0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # qiskit.aqua.components.multiclass\_extensions.AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index cd12c28cb2c..0d57860c84d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # qiskit.aqua.components.multiclass\_extensions.ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 2129162570a..bbdabbf6272 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # qiskit.aqua.components.multiclass\_extensions.MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index 33bb508dbbc..865bfb28bc6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # qiskit.aqua.components.multiclass\_extensions.OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index a45c778e813..2527bbad171 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # qiskit.aqua.components.neural\_networks.DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index f6cdba6d88e..73ee445876a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # qiskit.aqua.components.neural\_networks.GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### parameter\_values - + Get parameter values from the generator **Raises** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_discriminator - + Set discriminator network. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 40fb17633a9..f3848f3ef64 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # qiskit.aqua.components.neural\_networks.NumPyDiscriminator - + Discriminator based on NumPy **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 823ede5c275..0a05effe1d3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # qiskit.aqua.components.neural\_networks.PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index f732cfcf18a..4c2fae2b47c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # qiskit.aqua.components.neural\_networks.QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### discriminator - + Get discriminator. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### optimizer - + Get optimizer. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### parameter\_values - + Get parameter values from the quantum generator **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### seed - + Get seed. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.mdx index ef0b3809602..d543488872d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # qiskit.aqua.components.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.mdx index 0731c83bfb1..5f0039e33cf 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # qiskit.aqua.components.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,67 +130,67 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -248,13 +248,13 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.mdx index fd229abcf44..2fe30b6a348 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # qiskit.aqua.components.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.mdx index c5fd74e0b3d..55991c45ef6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # qiskit.aqua.components.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.mdx index 499e3a0dcc4..cf92c2aa1f5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # qiskit.aqua.components.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.mdx index 4038d116bc6..6af8a69bb30 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # qiskit.aqua.components.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8590001ac6e..c366c241344 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # qiskit.aqua.components.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 5604b313590..24b96919ef5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # qiskit.aqua.components.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.mdx index 469f5723bea..2104a1dfbb2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # qiskit.aqua.components.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.mdx index 333de2bed74..f5709158210 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # qiskit.aqua.components.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -127,7 +127,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -148,67 +148,67 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -340,13 +340,13 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.mdx index 397d9b5d42f..6189dd64722 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # qiskit.aqua.components.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.mdx index dba0fd9ba85..787d714a167 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # qiskit.aqua.components.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index c71bf7bd60b..48781e0581f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # qiskit.aqua.components.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index e6d33b5e282..135243451c7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # qiskit.aqua.components.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.mdx index 8227d7f2657..89bf21aadaf 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # qiskit.aqua.components.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.mdx index 0d1f3c01877..e9ac0f94c38 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # qiskit.aqua.components.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 275f472c907..bee2a0085c6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # qiskit.aqua.components.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.mdx index ad3ccd73021..560a4a48ac2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # qiskit.aqua.components.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.mdx index 0aea4556549..46f960acb37 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # qiskit.aqua.components.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.mdx index 7a58312796e..dbf3bd6ae15 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # qiskit.aqua.components.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.mdx index f3811b85da2..bdbe0897f01 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # qiskit.aqua.components.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.mdx index d9e1bb08faf..b1b4f2a2d4f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # qiskit.aqua.components.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -123,67 +123,67 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -237,13 +237,13 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.mdx index 597a684e2ba..e7fc949f6c2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # qiskit.aqua.components.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index e3942f76ec3..85caa6d3eb4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # qiskit.aqua.components.oracles.CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. @@ -69,13 +69,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -93,13 +93,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 3c4f757da7f..225d8475579 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # qiskit.aqua.components.oracles.LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -102,13 +102,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.mdx index 4115a2a9516..db9a3fc404d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # qiskit.aqua.components.oracles.Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -42,17 +42,17 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit - + Construct the oracle circuit. **Returns** @@ -62,13 +62,13 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b568f4c946e..6e67e33a39a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # qiskit.aqua.components.oracles.TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -90,13 +90,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.mdx index 12733381322..24685415d29 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # qiskit.aqua.components.reciprocals.LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.mdx index 81ea9c033da..417d4781447 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # qiskit.aqua.components.reciprocals.LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 557c97bc0a2..738b9c885b1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # qiskit.aqua.components.reciprocals.Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 6a50517d42c..27020a2a802 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # qiskit.aqua.components.uncertainty\_models.BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -142,35 +142,35 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### p - + ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### probabilities - + returns probabilities @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 22f28459568..21814d6362d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # qiskit.aqua.components.uncertainty\_models.GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### dimension - + returns dimensions @@ -158,49 +158,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 8d3315a2130..5f2b33ad2a4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # qiskit.aqua.components.uncertainty\_models.LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index c0b41887189..51fef3b7216 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # qiskit.aqua.components.uncertainty\_models.MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index eeb289bbe79..5b097bc040f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # qiskit.aqua.components.uncertainty\_models.MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 528b48c7586..23cf44e5f64 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # qiskit.aqua.components.uncertainty\_models.MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### dimension - + returns dimensions @@ -154,49 +154,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 830531fd516..51c9f5cc508 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index b3e63aba43e..b160ede9953 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # qiskit.aqua.components.uncertainty\_models.MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### dimension - + returns dimensions @@ -153,49 +153,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 46c3114ba4b..2dd748bb414 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # qiskit.aqua.components.uncertainty\_models.NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index e526ca3b43f..afbc8f9571e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # qiskit.aqua.components.uncertainty\_models.UncertaintyModel - + The abstract Uncertainty Model ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index 10ecbbbfbed..69cadc04f36 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # qiskit.aqua.components.uncertainty\_models.UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -141,31 +141,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### probabilities - + returns probabilities @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index 5a533bc58a2..316c48d150c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # qiskit.aqua.components.uncertainty\_models.UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -149,31 +149,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### probabilities - + returns probabilities @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index a364b9274d4..cc7e1006e8b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # qiskit.aqua.components.uncertainty\_models.UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -144,31 +144,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### probabilities - + returns probabilities @@ -217,7 +217,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### values - + returns values diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index 1c741bf2770..c6ab224913b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # qiskit.aqua.components.uncertainty\_problems.MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index 0e99e008c48..8c02d908cb8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # qiskit.aqua.components.uncertainty\_problems.UncertaintyProblem - + The abstract Uncertainty Problem component. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 5ac5955c5f7..0eeb0cb862f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # qiskit.aqua.components.uncertainty\_problems.UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: @@ -156,7 +156,7 @@ $$ ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index ccb460fb0f1..4b9b92d7e2a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # qiskit.aqua.components.uncertainty\_problems.UnivariateProblem - + Univariate uncertainty problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 0678df8bfc8..7007118837f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # qiskit.aqua.components.variational\_forms.VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### parameter\_bounds - + Parameter bounds. **Returns** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -116,11 +116,11 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.mdx index 4787352dbf8..bc4da1df0d2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.OperatorBase # qiskit.aqua.operators.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -177,7 +177,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -223,13 +223,13 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -315,7 +315,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -333,7 +333,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -353,7 +353,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 933592cb462..7ebc23253d9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # qiskit.aqua.operators.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.mdx index 5baddfcd2da..34fb0135015 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # qiskit.aqua.operators.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.mdx index 7d7dd8b170e..fa26b966c60 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # qiskit.aqua.operators.converters.ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index fc1aa54d7cf..a0e101f50fc 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # qiskit.aqua.operators.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 898ddc4fdb9..e7b77dd00f0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # qiskit.aqua.operators.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index a427ad49246..10782a3f3c5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # qiskit.aqua.operators.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index e463579330b..3e5ea422e91 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # qiskit.aqua.operators.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 6671c0f0f55..c828cc94cad 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # qiskit.aqua.operators.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -318,7 +318,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 286379421e5..d956a66efe0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # qiskit.aqua.operators.evolutions.MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index fe260118b9c..b33caa97fda 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # qiskit.aqua.operators.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.mdx index a777c872bc0..1493bf248e3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # qiskit.aqua.operators.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.mdx index ca0e463ca78..86b630b7026 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # qiskit.aqua.operators.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.mdx index f15b03435a4..480f6d58bd3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # qiskit.aqua.operators.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index cf919be5d48..361cbcf46fb 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # qiskit.aqua.operators.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 5e1f161079f..e69c3dedc31 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # qiskit.aqua.operators.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index 6999acf26ea..51f3206af90 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # qiskit.aqua.operators.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index 8e7df6d553f..4f5d780842c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # qiskit.aqua.operators.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 6c707d3988a..2f2707fcc05 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # qiskit.aqua.operators.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index f371ab0f386..dd297a5dfb3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # qiskit.aqua.operators.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index b2d0f7f4fc6..dcd55e48373 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # qiskit.aqua.operators.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.mdx index f4ae2b360d4..eaa155c0007 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # qiskit.aqua.operators.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a5ed172688b..7a8b5fd47e6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # qiskit.aqua.operators.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 8c3cd57f155..d49eded58c7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # qiskit.aqua.operators.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.mdx index cd28266e80e..f35162560af 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # qiskit.aqua.operators.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.mdx index 6ce8fd8a006..c14b662068b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # qiskit.aqua.operators.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.mdx index d565bbe49b5..7f41eb6829f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # qiskit.aqua.operators.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.mdx index 228cd12c85b..e8a0930eb53 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # qiskit.aqua.operators.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.mdx index 523cf619b37..f9876785c80 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # qiskit.aqua.operators.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.mdx index 29a31c4ad41..d32a409297e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # qiskit.aqua.operators.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.mdx index 7b013ca4d6e..da7ce1abd05 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # qiskit.aqua.operators.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parametrized quantum state, where QFI is: @@ -93,7 +93,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -112,7 +112,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.mdx index 613712d91a6..bfc269a4012 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # qiskit.aqua.operators.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parametrized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index c2f2beb55c0..bb98926c622 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # qiskit.aqua.operators.legacy.LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. ### \_\_init\_\_ - + Constructor. @@ -43,65 +43,65 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### basis - + returns basis ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### name - + returns name ### num\_qubits - + Returns number of qubits for operator ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 8cc914ff1bb..33e330bfa3c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # qiskit.aqua.operators.legacy.MatrixOperator - + Operators relevant for quantum applications @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### atol - + return atol ### basis - + returns basis @@ -131,13 +131,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### dense\_matrix - + Getter of matrix in dense matrix form. ### dia\_matrix - + diagonal matrix @@ -229,19 +229,19 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### matrix - + Getter of matrix. ### name - + returns name ### num\_qubits - + number of qubits required for the operator. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.mdx index 924e12d688d..5de75ef72ea 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # qiskit.aqua.operators.legacy.PauliGraph - + Pauli Graph. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph ### grouped\_paulis - + Getter of grouped Pauli list. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index e95b8cffdc7..b093ac18b44 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -108,13 +108,13 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -349,7 +349,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -368,7 +368,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -392,7 +392,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### grouping\_func - + returns grouping function @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### kwargs - + returns kwargs @@ -438,19 +438,19 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### name - + returns name ### num\_groups - + returns number of groups ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -464,7 +464,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### paulis - + get paulis @@ -539,7 +539,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -607,7 +607,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** @@ -625,7 +625,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 410f6d99cf1..1d422f494e1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # qiskit.aqua.operators.legacy.WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -99,13 +99,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -340,7 +340,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -415,13 +415,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### name - + returns name ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -435,7 +435,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### paulis - + get paulis @@ -559,7 +559,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index c2ef9da6c81..143a95207d0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # qiskit.aqua.operators.legacy.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. **Returns** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -139,19 +139,19 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -182,13 +182,13 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### tapering\_values - + returns tapering values ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 4e03fb5a52f..e7ce512e2c8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # qiskit.aqua.operators.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.mdx index c47867a18b2..0a7693ab4c3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # qiskit.aqua.operators.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.mdx index 2cdc1ee7d9e..1cc90a4070e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # qiskit.aqua.operators.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.mdx index e746124092a..eed67051ce7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # qiskit.aqua.operators.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index 6a491e3279f..3177f692897 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # qiskit.aqua.operators.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -324,7 +324,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index ba012dc5fb2..5a627740ba5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # qiskit.aqua.operators.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -328,7 +328,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index c43d201e415..931a3f988b1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # qiskit.aqua.operators.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -346,7 +346,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 83a54c620f2..838e7612f3d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # qiskit.aqua.operators.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index cefc082b6de..dfa6ef23fad 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # qiskit.aqua.operators.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index 0919f90636a..b1f641beaab 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # qiskit.aqua.operators.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.mdx index 81bf9c2c4ac..61dea24e238 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # qiskit.aqua.operators.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 440aea8d541..ebf15d8e7cc 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # qiskit.aqua.operators.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.mdx index 9aedab6571c..08d0478bb5a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # qiskit.aqua.operators.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -304,7 +304,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 1a99e0ab803..46eadd524ac 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # qiskit.aqua.operators.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.mdx index 063b279fc6e..46cbc653ae5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # qiskit.aqua.utils.CircuitFactory - + Base class for CircuitFactories ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.mdx index deb6f41b8aa..d7d143ad6ac 100644 --- a/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # qiskit.assembler.RunConfig - + Class for Run Configuration. ### shots @@ -97,7 +97,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.mdx index ae81b901aae..d49bcf65352 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # qiskit.chemistry.BosonicOperator - + A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.mdx index 556c2a3ff8d..707ca90e5f4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # qiskit.chemistry.FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: @@ -127,13 +127,13 @@ python_api_name: qiskit.chemistry.FermionicOperator ### h1 - + Getter of one body integral tensor. ### h2 - + Getter of two body integral tensor. @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.FermionicOperator ### modes - + Getter of modes. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.mdx index c2b377d45e7..fc1c0380536 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # qiskit.chemistry.MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_delta - + Get the MP2 delta energy correction for the molecule **Returns** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_energy - + Get the MP2 energy for the molecule **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.mdx index 14a734d0ea7..42d44f3c935 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # qiskit.chemistry.QMolecule - + Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.QMolecule ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.QMolecule ### filename - + returns temp file path @@ -96,13 +96,13 @@ python_api_name: qiskit.chemistry.QMolecule ### one\_body\_integrals - + Returns one body electron integrals. ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -157,13 +157,13 @@ python_api_name: qiskit.chemistry.QMolecule ### two\_body\_integrals - + Returns two body electron integrals. ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -186,7 +186,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -207,23 +207,23 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ### x\_dipole\_integrals - + returns x\_dipole\_integrals ### y\_dipole\_integrals - + returns y\_dipole\_integrals ### z\_dipole\_integrals - + returns z\_dipole\_integrals diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.mdx index 45da8572dcd..ccb0d52f7a2 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.mdx index 57c3baba265..4bb91464db2 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # qiskit.chemistry.WatsonHamiltonian - + Watson Hamiltonian class containing the results of a driver’s anharmonic calculation **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### data - + Returns the matrix elements of the Hamiltonian **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### num\_modes - + Returns the number of modes **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.mdx index 5712c6b1d7e..10d3766d08a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # qiskit.chemistry.algorithms.AdaptVQE - + A ground state calculation employing the AdaptVQE algorithm. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.mdx index c75a433cbe4..b004204cd19 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # qiskit.chemistry.algorithms.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 1686584e54e..8f837c70792 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # qiskit.chemistry.algorithms.EigensolverFactory - + A factory to construct a eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index 8d7068dcde7..c45e4b8bb74 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # qiskit.chemistry.algorithms.ExcitedStatesEigensolver - + The calculation of excited states via an Eigensolver algorithm **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 6f28d97e44f..c9d661eb9a5 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # qiskit.chemistry.algorithms.ExcitedStatesSolver - + The excited states calculation interface ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index 049d02842ec..31a09b74c85 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # qiskit.chemistry.algorithms.GroundStateEigensolver - + Ground state computation using a minimum eigensolver. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.mdx index a002dbd0c3e..e50c38a15a1 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # qiskit.chemistry.algorithms.GroundStateSolver - + The ground state calculation interface **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index b8a0edc1c32..5d10457f982 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # qiskit.chemistry.algorithms.MinimumEigensolverFactory - + A factory to construct a minimum eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index bbd3a1ddb68..5f614a46726 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # qiskit.chemistry.algorithms.NumPyEigensolverFactory - + A factory to construct a NumPyEigensolver. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### k - + returns k (number of eigenvalues requested) **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index a4bf14b44a3..fefb70f9093 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory - + A factory to construct a NumPyMinimumEigensolver. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index e5528c63fe3..e8d5c65a150 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # qiskit.chemistry.algorithms.OrbitalOptimizationVQE - + A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.mdx index 155c7f29498..b19172b381e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # qiskit.chemistry.algorithms.QEOM - + The calculation of excited states via the qEOM algorithm **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM ### excitations - + Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.mdx index c99651d042d..f7ac0463f6b 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # qiskit.chemistry.algorithms.QEomEE - + QEomEE algorithm (classical) **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### random - + Return a numpy random. @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.mdx index e429ecb926b..36ba3a7482f 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # qiskit.chemistry.algorithms.QEomVQE - + QEomVQE algorithm **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### random - + Return a numpy random. @@ -371,13 +371,13 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -393,7 +393,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.mdx index c49597fb26e..84fcedb1479 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # qiskit.chemistry.algorithms.VQEAdapt - + DEPRECATED. The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -166,13 +166,13 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -182,7 +182,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### random - + Return a numpy random. @@ -231,7 +231,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 28a0bb2ea8a..336e3102f39 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # qiskit.chemistry.algorithms.VQEUCCSDFactory - + A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### excitation\_type - + Getter of the `excitation_type` setting for the `excitation_type` setting. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_doubles - + Getter of the `method_doubles` setting for the `method_doubles` setting. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_singles - + Getter of the `method_singles` setting for the `method_singles` setting. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### same\_spin\_doubles - + Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index 56ad20a7469..544678a0c18 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # qiskit.chemistry.algorithms.VQEUVCCSDFactory - + A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 443eed81800..42d93c09387 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # qiskit.chemistry.algorithms.pes\_samplers.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index 65d0d472d1e..8b778a0d359 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # qiskit.chemistry.algorithms.pes\_samplers.DifferentialExtrapolator - + An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. Constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 84212db2c03..76fbb133fae 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # qiskit.chemistry.algorithms.pes\_samplers.EnergySurface1DSpline - + A simple cubic spline interpolation for the potential energy surface. A spline interpolation method for data fitting. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 3e97db2bc4f..d4ffd4621d7 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # qiskit.chemistry.algorithms.pes\_samplers.EnergySurfaceBase - + Class to hold a potential energy surface ### \_\_init\_\_ @@ -30,7 +30,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 84a5c18de02..9165093f82e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # qiskit.chemistry.algorithms.pes\_samplers.Extrapolator - + This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. Each instance of an Extrapolator requires a dictionary where each item consist of a point (key) and a list of variational parameters (value) for that given point. In practice, a Sampler Class can utilize the Extrapolator as a wrapper. The Extrapolator class then extracts optimal variational parameters from the previous points for use in extrapolation. For instance, one can utilize the Extrapolator to accelerate the computation of the Born-Oppenheimer Potential Energy Surface (BOPES) for a given molecule. In this case, each point can represent the interatomic distance and the list of parameters represent rotational parameters in a quantum circuit, in the context of computing the bond dissociation profile for a diatomic molecule. NOTE: However this is not a requirement - once an instance of the Extrapolator class is created, extrapolation can proceed by specifying the point(s) of interest and the dictionary of (point, parameter) pairs for a problem. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index 641fc6c3308..7a703d8b595 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # qiskit.chemistry.algorithms.pes\_samplers.HarmonicPotential - + Implements a 1D Harmonic potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + **Mostly for internal use. Preprocesses the data passed to fit\_to\_data()** so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 6197220d86a..141f6d4b0b6 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # qiskit.chemistry.algorithms.pes\_samplers.MorsePotential - + Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 44468f8e352..67e8ca8a7b3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PCAExtrapolator - + A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. Constructor. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index 337b214f283..3de1b074082 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PolynomialExtrapolator - + An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 953d1ee37a0..0250897ea92 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # qiskit.chemistry.algorithms.pes\_samplers.PotentialBase - + Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index 3c67abc8f76..202958a6a30 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.SieveExtrapolator - + A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. Constructor. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index 002af5ea244..ec3bc4b8640 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # qiskit.chemistry.algorithms.pes\_samplers.VibronicStructureBase - + Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 650f2acfed1..0f7dd5c2eee 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.WindowExtrapolator - + An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. Constructor. @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### extrapolator - + Returns the internal extrapolator. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### window - + Returns the size of the window. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index 34e4da3f0c4..c8581e90b98 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # qiskit.chemistry.applications.MolecularGroundStateEnergy - + Molecular ground state energy chemistry application **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### driver - + Returns chemistry driver **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### solver - + Returns minimum eigen solver **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 89111f7e7a3..1c4e110e046 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # qiskit.chemistry.components.bosonic\_bases.BosonicBasis - + Basis to express a second quantization Bosonic Hamiltonian. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 4f35286f61f..dab39d88a4e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # qiskit.chemistry.components.bosonic\_bases.HarmonicBasis - + Basis in which the Watson Hamiltonian is expressed. This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) as a modal basis for the expression of the Watson Hamiltonian or any bosonic operator. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0a607b86123..a4fc9327b76 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # qiskit.chemistry.components.initial\_states.HartreeFock - + A Hartree-Fock initial state. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.mdx index 3573ece0570..a9ea53953b9 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # qiskit.chemistry.components.initial\_states.VSCF - + Initial state for vibrational modes. Creates an occupation number vector as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. e.g. for 2 modes with 4 modals per mode it creates: |1000 1000> @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.mdx index 721e5653143..96e4629a59c 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # qiskit.chemistry.components.variational\_forms.CHC - + This trial wavefunction is the Compact Heuristic for Chemistry. The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. It aims at approximating the UCC Ansatz for a lower CNOT count. @@ -86,13 +86,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -142,11 +142,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.mdx index 59b6ee0d9ff..fed06dc156b 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # qiskit.chemistry.components.variational\_forms.UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -209,13 +209,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### double\_excitations - + Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] ### excitation\_pool - + Returns the full list of available excitations (called the pool). **Return type** @@ -225,13 +225,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -275,7 +275,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### parameter\_bounds - + Parameter bounds. **Returns** @@ -342,7 +342,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -358,7 +358,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -382,17 +382,17 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### setting - + ### single\_excitations - + Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.mdx index b1374beb072..788145ce31e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # qiskit.chemistry.components.variational\_forms.UVCC - + This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -126,13 +126,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -182,11 +182,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -200,7 +200,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.mdx index e1aeaf92671..0dcfe95e6e0 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,12 +8,12 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # qiskit.chemistry.core.ChemistryOperator - + Base class for ChemistryOperator. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### molecule\_info - + returns molecule info @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.mdx index 8843e492624..00d4ae27ad0 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # qiskit.chemistry.core.Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### molecule\_info - + returns molecule info diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.mdx index 2f3b74c1c13..9960bbe4a4a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # qiskit.chemistry.core.MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 74542543f4b..9fb56ed0560 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # qiskit.chemistry.core.MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 3beb168f157..30c91adb960 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # qiskit.chemistry.core.MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.mdx index e4a1697a231..a9aff48d83a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # qiskit.chemistry.core.QubitMappingType - + QubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.mdx index 262ec05ebbc..58368e87694 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # qiskit.chemistry.core.TransformationType - + Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.mdx index ac19637363a..91e8c384daa 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # qiskit.chemistry.drivers.BaseDriver - + Base class for Qiskit’s chemistry drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### basis - + return basis **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### molecule - + return molecule **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.mdx index df886e5eab1..5d6330f8ca0 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # qiskit.chemistry.drivers.BasisType - + Basis Type ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.mdx index 48b7a932af8..eea5be18efe 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # qiskit.chemistry.drivers.BosonicDriver - + Base class for Qiskit’s chemistry bosonic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 2ac2ff37113..64af52d8b37 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # qiskit.chemistry.drivers.FCIDumpDriver - + Qiskit chemistry driver reading an FCIDump file. The FCIDump format is partially defined in Knowles1989. @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### basis - + return basis **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### molecule - + return molecule **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.mdx index 9698b0ba2e4..41f39e2dcac 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # qiskit.chemistry.drivers.FermionicDriver - + Base class for Qiskit’s chemistry fermionic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.mdx index 9ce181344d5..4b83193d6b3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # qiskit.chemistry.drivers.GaussianDriver - + Qiskit chemistry driver using the Gaussian™ 16 program. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index cd7ea2d7d8f..08d46359fff 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # qiskit.chemistry.drivers.GaussianForcesDriver - + Gaussian™ 16 forces driver. **Parameters** @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 9d606b4ad1b..e36dbee06aa 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # qiskit.chemistry.drivers.GaussianLogDriver - + Gaussian™ 16 log driver. Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.mdx index 4d3c5a5ce94..7ee96b06672 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # qiskit.chemistry.drivers.GaussianLogResult - + Result for Gaussian™ 16 log driver. This result allows access to selected data from the log file that is not available via the use Gaussian 16 interfacing code when using the MatrixElement file. Since this parses the text output it is subject to the format of the log file. @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### a\_to\_h\_numbering - + A to H numbering mapping. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### cubic\_force\_constants - + Cubic force constants. (3 indices, 3 values) **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### log - + The complete Gaussian log in the form of a list of strings. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quadratic\_force\_constants - + Quadratic force constants. (2 indices, 3 values) **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quartic\_force\_constants - + Quartic force constants. (4 indices, 3 values) **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.mdx index 3cefebe757f..948e73faea3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # qiskit.chemistry.drivers.HDF5Driver - + Qiskit chemistry driver reading an HDF5 file. The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### basis - + return basis **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### molecule - + return molecule **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### work\_path - + Returns work path. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.mdx index 36c88a55523..7af31402def 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # qiskit.chemistry.drivers.HFMethodType - + HFMethodType Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.mdx index b3623aea87e..099eda4e94f 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # qiskit.chemistry.drivers.InitialGuess - + Initial Guess Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.mdx index 4736dcd3c34..adde40ac520 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # qiskit.chemistry.drivers.Molecule - + Driver-independent Molecule definition. This module implements an interface for a driver-independent, i.e. generic molecule definition. It defines the composing atoms (with properties like masses), and allows for changing the molecular geometry through given degrees of freedom (e.g. bond-stretching, angle-bending, etc.). The geometry as provided in the constructor can be affected, through setting perturbations, and it is this perturbed geometry that is supplied by the geometry getter. Setting perturbations to None will cause the original geometry to be returned, and there is a getter to get this value directly if its needed. @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### charge - + Get charge **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### geometry - + Get geometry accounting for any perturbations **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### masses - + Get masses **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### multiplicity - + Get multiplicity **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### perturbations - + Get perturbations **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -206,7 +206,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) @@ -224,7 +224,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### units - + The geometry coordinate units diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.mdx index 3fb20d1d394..bd018fbd6f3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # qiskit.chemistry.drivers.PSI4Driver - + Qiskit chemistry driver using the PSI4 program. See [http://www.psicode.org/](http://www.psicode.org/) @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.mdx index b2106147207..423d3eabda9 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # qiskit.chemistry.drivers.PyQuanteDriver - + Qiskit chemistry driver using the PyQuante2 library. See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante2) @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### basis - + return basis **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### molecule - + return molecule **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.mdx index 29b4d848a11..24879916fd1 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # qiskit.chemistry.drivers.PySCFDriver - + Qiskit chemistry driver using the PySCF library. See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### basis - + return basis **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### molecule - + return molecule **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.mdx index f9fa0412ddf..83a3a911c16 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # qiskit.chemistry.drivers.UnitsType - + Units Type Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.mdx index 36205b5512a..a786749378f 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # qiskit.chemistry.results.BOPESSamplerResult - + The BOPES Sampler result Creates an new instance of the result. :type points: `List`\[`float`] :param points: List of points. :type energies: `List`\[`float`] :param energies: List of energies. :type raw\_results: `Dict`\[`float`, `EigenstateResult`] :param raw\_results: Raw results obtained from the solver. @@ -36,7 +36,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### energies - + returns list of energies. **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### points - + returns list of points. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### raw\_results - + returns all results for all points. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.mdx index 954cc118e43..12f2c70edb4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # qiskit.chemistry.results.EigenstateResult - + The eigenstate result interface. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenenergies - + returns eigen energies **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenstates - + returns eigen states **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundenergy - + returns ground energy **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundstate - + returns ground state **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.mdx index da8d5298511..c3e8534fcb4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # qiskit.chemistry.results.ElectronicStructureResult - + The electronic structure result. ### \_\_init\_\_ @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_energies - + Returns electronic part of ground state energy **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundstate - + returns ground state **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### magnetization - + Returns measured magnetization **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### num\_particles - + Returns measured number of particles **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -376,7 +376,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### spin - + Returns computed spin **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -396,7 +396,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** @@ -416,7 +416,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_energies - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.mdx index a887eb829fe..c41c7b869cf 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # qiskit.chemistry.results.VibronicStructureResult - + The vibronic structure result. ### \_\_init\_\_ @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### computed\_vibronic\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundstate - + returns ground state **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### num\_occupied\_modals\_per\_mode - + Returns the number of occupied modal per mode **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 92a08ff1be8..f43a2851888 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # qiskit.chemistry.transformations.BosonicQubitMappingType - + BosonicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.mdx index 10ae059df90..2106cb09a1a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # qiskit.chemistry.transformations.BosonicTransformation - + A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### basis - + returns the basis (number of modals per mode) **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### num\_modes - + the number of modes **Type** @@ -147,7 +147,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.mdx index 3fcffefe2ae..c30b6fb37ef 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # qiskit.chemistry.transformations.BosonicTransformationType - + BosonicTransformationType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index fd03b5106aa..ffde0817035 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # qiskit.chemistry.transformations.FermionicQubitMappingType - + FermionicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.mdx index b1c59782d78..d35778e2310 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # qiskit.chemistry.transformations.FermionicTransformation - + A transformation from a fermionic problem, represented by a driver, to a qubit operator. **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### molecule\_info - + Getter of the molecule information. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### qubit\_mapping - + Getter of the qubit mapping. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.mdx index ccd64026ceb..440aa1e271c 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # qiskit.chemistry.transformations.FermionicTransformationType - + Electronic Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.mdx index 169b0076a07..dae4e6f83d6 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # qiskit.chemistry.transformations.Transformation - + Base class for transformation to qubit operators for chemistry problems ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.mdx index 0b0ae623073..b3281422238 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # qiskit.circuit.AncillaQubit - + A qubit used as ancillary qubit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.AncillaQubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.mdx index c6971c51192..eb116e3822d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # qiskit.circuit.AncillaRegister - + Implement an ancilla register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.mdx index 0f0b3c1169f..6e040f63c60 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # qiskit.circuit.ClassicalRegister - + Implement a classical register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Clbit.mdx index b4c5ce884ae..c9d9a550d63 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # qiskit.circuit.Clbit - + Implement a classical bit. Creates a classical bit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Clbit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.mdx index f67a23e0354..7091f6ed192 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # qiskit.circuit.ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -324,13 +324,13 @@ python_api_name: qiskit.circuit.ControlledGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.ControlledGate ### duration - + Get the duration. @@ -362,7 +362,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return gate label **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.circuit.ControlledGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.ControlledGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.ControlledGate ### params - + Get parameters from base\_gate. **Returns** @@ -540,7 +540,7 @@ python_api_name: qiskit.circuit.ControlledGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Delay.mdx index 7f711f95e1b..3143ff8d521 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # qiskit.circuit.Delay - + Do nothing and just delay/wait/idle for a specified duration. Create new delay instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Delay ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration of this delay. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.Delay ### params - + return instruction params. @@ -240,7 +240,7 @@ python_api_name: qiskit.circuit.Delay ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.mdx index 00f71e10fbe..132c39310f7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # qiskit.circuit.EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Gate.mdx index 67be8b2a688..3464948ed55 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # qiskit.circuit.Gate - + Unitary gate. Create a new gate. @@ -187,19 +187,19 @@ python_api_name: qiskit.circuit.Gate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return gate label **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.circuit.Gate ### params - + return instruction params. @@ -371,7 +371,7 @@ python_api_name: qiskit.circuit.Gate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Instruction.mdx index 4014dc71d70..53b83c3b99c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # qiskit.circuit.Instruction - + Generic quantum instruction. Create a new instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.circuit.Instruction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.Instruction ### params - + return instruction params. @@ -267,7 +267,7 @@ python_api_name: qiskit.circuit.Instruction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.mdx index 3cd05f0003e..b3ad228266e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # qiskit.circuit.InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Measure.mdx index e4ebf16f584..3f5840d2486 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # qiskit.circuit.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Parameter.mdx index 806e44c059a..9b1c2d7d91e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # qiskit.circuit.Parameter - + Parameter Class for variable parameters. Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). @@ -166,13 +166,13 @@ python_api_name: qiskit.circuit.Parameter ### name - + Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.mdx index 0c123d87771..7535c0371b9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # qiskit.circuit.ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). @@ -171,7 +171,7 @@ python_api_name: qiskit.circuit.ParameterExpression ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.mdx index 1f89d746816..8c9ee0b0bbb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # qiskit.circuit.ParameterVector - + ParameterVector class to quickly generate lists of parameters. ### \_\_init\_\_ @@ -40,13 +40,13 @@ python_api_name: qiskit.circuit.ParameterVector ### name - + Returns the name of the ParameterVector. ### params - + Returns the list of parameters in the ParameterVector. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.mdx index 8bcd80c510a..f7f6b347c04 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # qiskit.circuit.QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -323,7 +323,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -482,7 +482,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -492,7 +492,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -528,19 +528,19 @@ python_api_name: qiskit.circuit.QuantumCircuit ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -758,7 +758,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### data - + Return the circuit data (instructions and context). **Returns** @@ -971,7 +971,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -989,7 +989,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1007,7 +1007,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### global\_phase - + Return the global phase of the circuit in radians. @@ -1420,7 +1420,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1434,13 +1434,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1472,13 +1472,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1506,7 +1506,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1653,7 +1653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.mdx index 06b8f372671..427b50414e5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # qiskit.circuit.QuantumRegister - + Implement a quantum register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Qubit.mdx index 8f18a4b8a5b..9c1d1c5eb6a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # qiskit.circuit.Qubit - + Implement a quantum bit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Qubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.27/qiskit.circuit.Reset.mdx index dab23df6ede..d5e4389b4ac 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # qiskit.circuit.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 6d7b7af0269..844b59e8d23 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # qiskit.circuit.classicalfunction.BooleanExpression - + The Boolean Expression gate. **Parameters** @@ -190,25 +190,25 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### label - + Return gate label **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### params - + return instruction params. @@ -432,7 +432,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 7b3676d0dae..1546e2d239e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # qiskit.circuit.classicalfunction.ClassicalFunction - + Represent a classical function function and its logic network. Creates a `ClassicalFunction` from Python source code in `source`. @@ -94,7 +94,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### args - + Returns the classicalfunction arguments @@ -219,19 +219,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### label - + Return gate label **Return type** @@ -291,13 +291,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### network - + Returns the logical network ### params - + return instruction params. @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### qregs - + The list of qregs used by the classicalfunction @@ -379,7 +379,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### scopes - + Returns the scope dict @@ -476,13 +476,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### truth\_table - + Returns (and computes) the truth table ### types - + Dumps a list of scopes with their variables and types. **Returns** @@ -496,7 +496,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4e8d89a0540..06ac2b44dce 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 440d4532159..b13f84a2a7f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.AND.mdx index adb8690b2f5..34ccbfd130e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # qiskit.circuit.library.AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -242,7 +242,7 @@ python_api_name: qiskit.circuit.library.AND ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -401,7 +401,7 @@ python_api_name: qiskit.circuit.library.AND ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -447,19 +447,19 @@ python_api_name: qiskit.circuit.library.AND ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -677,7 +677,7 @@ python_api_name: qiskit.circuit.library.AND ### data - + Return the circuit data (instructions and context). **Returns** @@ -890,7 +890,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -908,7 +908,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -926,7 +926,7 @@ python_api_name: qiskit.circuit.library.AND ### global\_phase - + Return the global phase of the circuit in radians. @@ -1339,7 +1339,7 @@ python_api_name: qiskit.circuit.library.AND ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1353,13 +1353,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1391,13 +1391,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1425,7 +1425,7 @@ python_api_name: qiskit.circuit.library.AND ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1572,7 +1572,7 @@ python_api_name: qiskit.circuit.library.AND ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.mdx index f04f40eeaca..ae107288303 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # qiskit.circuit.library.Barrier - + Barrier instruction. Create new barrier instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Barrier ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.library.Barrier ### params - + return instruction params. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.Barrier ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.mdx index 9fcd4dc4048..df0585a6fe5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # qiskit.circuit.library.C3SXGate - + The 3-qubit controlled sqrt-X gate. This implementation is based on Page 17 of \[1]. @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -204,13 +204,13 @@ python_api_name: qiskit.circuit.library.C3SXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### params - + Get parameters from base\_gate. **Returns** @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.mdx index b71a6f73b86..e232348a667 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # qiskit.circuit.library.C3XGate - + The 4-qubit controlled X gate. This implementation uses $\sqrt{T}$ and 14 CNOT gates. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.C3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### duration - + Get the duration. @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return gate label **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### params - + Get parameters from base\_gate. **Returns** @@ -396,7 +396,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.mdx index f214afe8823..5c5cfda9906 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # qiskit.circuit.library.C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1], with the use of the relative phase version of c3x, the rc3x \[2]. @@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -188,13 +188,13 @@ python_api_name: qiskit.circuit.library.C4XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### params - + Get parameters from base\_gate. **Returns** @@ -400,7 +400,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.mdx index 658a6a6b86a..199f906c493 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # qiskit.circuit.library.CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** @@ -228,7 +228,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -238,13 +238,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -254,7 +254,7 @@ $$ ### duration - + Get the duration. @@ -272,7 +272,7 @@ $$ ### label - + Return gate label **Return type** @@ -298,7 +298,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -312,7 +312,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -326,7 +326,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -450,7 +450,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.mdx index 3d83e02c772..862287fd647 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # qiskit.circuit.library.CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. @@ -223,7 +223,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -233,13 +233,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -249,7 +249,7 @@ $$ ### duration - + Get the duration. @@ -267,7 +267,7 @@ $$ ### label - + Return gate label **Return type** @@ -293,7 +293,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -307,7 +307,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -321,7 +321,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -445,7 +445,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.mdx index 287c7b6c362..a874a477ab4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # qiskit.circuit.library.CPhaseGate - + Controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.mdx index 6dd6abd6b7b..8d5e3a9223c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # qiskit.circuit.library.CRXGate - + Controlled-RX gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.mdx index 85560f7ec9b..33b08027b5d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # qiskit.circuit.library.CRYGate - + Controlled-RY gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.mdx index 820c2d7c629..f0212271a13 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # qiskit.circuit.library.CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -226,7 +226,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -236,13 +236,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -252,7 +252,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.mdx index 7b80f2d7f0b..a208b522311 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # qiskit.circuit.library.CSXGate - + Controlled-√X gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -268,7 +268,7 @@ $$ ### label - + Return gate label **Return type** @@ -294,7 +294,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -308,7 +308,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -322,7 +322,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -446,7 +446,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.mdx index d46ee153681..98c5fee02e2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # qiskit.circuit.library.CSwapGate - + Controlled-X gate. **Circuit symbol:** @@ -239,7 +239,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -249,13 +249,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -265,7 +265,7 @@ $$ ### duration - + Get the duration. @@ -283,7 +283,7 @@ $$ ### label - + Return gate label **Return type** @@ -309,7 +309,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -323,7 +323,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -337,7 +337,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -461,7 +461,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.mdx index f27051341f6..569fe5db52e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # qiskit.circuit.library.CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -199,7 +199,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -209,13 +209,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -225,7 +225,7 @@ $$ ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -283,7 +283,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -297,7 +297,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -421,7 +421,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.mdx index 33793c4aa91..4d8756ed06d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # qiskit.circuit.library.CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.mdx index 34768816364..f7f98793b8f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # qiskit.circuit.library.CUGate - + Controlled-U gate (4-parameter two-qubit gate). This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $e^{i\gamma}$ of the U gate. @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -310,7 +310,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -324,7 +324,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -448,7 +448,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.mdx index 1da615ebb22..70cb1ed00f3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # qiskit.circuit.library.CXGate - + Controlled-X gate. **Circuit symbol:** @@ -222,7 +222,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -232,13 +232,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -248,7 +248,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return gate label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.mdx index 8ea7e3f1d76..64b9235ed47 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # qiskit.circuit.library.CYGate - + Controlled-Y gate. **Circuit symbol:** @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return gate label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.mdx index 8d0a179fd86..927190ee3f8 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # qiskit.circuit.library.CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. @@ -201,7 +201,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -211,13 +211,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -227,7 +227,7 @@ $$ ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -285,7 +285,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -299,7 +299,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.mdx index 116bae511b8..bdd4156ad90 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # qiskit.circuit.library.DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. @@ -195,19 +195,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.mdx index 6f2e3f845d3..45cb8020e77 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # qiskit.circuit.library.Diagonal - + Diagonal circuit. Circuit symbol: @@ -272,7 +272,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -431,7 +431,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -441,7 +441,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -477,19 +477,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -707,7 +707,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1369,7 +1369,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1383,13 +1383,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1421,13 +1421,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1455,7 +1455,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1602,7 +1602,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.mdx index 774d6497e43..b214acf5abf 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # qiskit.circuit.library.ECRGate - + An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). This gate is maximally entangling and is equivalent to a CNOT up to single-qubit pre-rotations. The echoing procedure mitigates some unwanted terms (terms other than ZX) to cancel in an experiment. @@ -219,19 +219,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -265,7 +265,7 @@ $$ ### label - + Return gate label **Return type** @@ -291,7 +291,7 @@ $$ ### params - + return instruction params. @@ -391,7 +391,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.mdx index 04af4a205af..80fac9be740 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # qiskit.circuit.library.EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + Return the circuit data (instructions and context). **Returns** @@ -872,7 +872,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -992,7 +992,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### global\_phase - + Return the global phase of the circuit in radians. @@ -1040,7 +1040,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1170,7 +1170,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1433,7 +1433,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1447,13 +1447,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1509,7 +1509,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1529,7 +1529,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1559,7 +1559,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1609,7 +1609,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1720,7 +1720,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qregs - + A list of the quantum registers associated with the circuit. @@ -1794,7 +1794,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1856,7 +1856,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1962,7 +1962,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.mdx index c5097d5f092..790363e0fae 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # qiskit.circuit.library.ExcitationPreserving - + The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -355,7 +355,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -909,7 +909,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -955,7 +955,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1015,7 +1015,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1063,7 +1063,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1193,7 +1193,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1456,7 +1456,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1470,13 +1470,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1500,7 +1500,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1522,7 +1522,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1532,7 +1532,7 @@ $$ ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1552,7 +1552,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1582,7 +1582,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1618,7 +1618,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1632,7 +1632,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1673,7 +1673,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1743,7 +1743,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1817,7 +1817,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1879,7 +1879,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1985,7 +1985,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.mdx index f6d6002555b..56aec71fc59 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # qiskit.circuit.library.FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -465,19 +465,19 @@ python_api_name: qiskit.circuit.library.FourierChecking ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -695,7 +695,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### data - + Return the circuit data (instructions and context). **Returns** @@ -908,7 +908,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -926,7 +926,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -944,7 +944,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### global\_phase - + Return the global phase of the circuit in radians. @@ -1357,7 +1357,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1371,13 +1371,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1409,13 +1409,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1443,7 +1443,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1590,7 +1590,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.mdx index daf0f0c7dd8..50af9c043ef 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # qiskit.circuit.library.FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -369,7 +369,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,7 +1363,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1377,13 +1377,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1425,13 +1425,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1467,7 +1467,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1550,7 +1550,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qregs - + A list of the quantum registers associated with the circuit. @@ -1624,7 +1624,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.mdx index f6aa86fa9aa..4ae1184afaf 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # qiskit.circuit.library.GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -261,7 +261,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -420,7 +420,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -430,7 +430,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -466,19 +466,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -696,7 +696,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -909,7 +909,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -927,7 +927,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -945,7 +945,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1358,7 +1358,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1372,13 +1372,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1410,13 +1410,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1444,7 +1444,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1591,7 +1591,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GR.mdx index e5c1e1fd7ef..47be925a795 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # qiskit.circuit.library.GR - + Global R gate. **Circuit symbol:** @@ -256,7 +256,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -904,7 +904,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -940,7 +940,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1353,7 +1353,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1367,13 +1367,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1405,13 +1405,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1439,7 +1439,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1586,7 +1586,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.mdx index 62b1610810f..595101dad95 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # qiskit.circuit.library.GRX - + Global RX gate. **Circuit symbol:** @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.mdx index d9c67970b9d..6b6f9dd1802 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # qiskit.circuit.library.GRY - + Global RY gate. **Circuit symbol:** @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.mdx index f8c4f4e3fe6..ac261787cb1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # qiskit.circuit.library.GRZ - + Global RZ gate. **Circuit symbol:** @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.mdx index a3dc3dd6928..18440b05e97 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # qiskit.circuit.library.GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.mdx index 50cf46ed2a0..7fde0d9223e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # qiskit.circuit.library.GroverOperator - + The Grover operator. Grover’s search algorithm \[1, 2] consists of repeated applications of the so-called Grover operator used to amplify the amplitudes of the desired output states. This operator, $\mathcal{Q}$, consists of the phase oracle, $\mathcal{S}_f$, zero phase-shift or zero reflection, $\mathcal{S}_0$, and an input state preparation $\mathcal{A}$: @@ -369,7 +369,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -528,7 +528,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -538,7 +538,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -574,19 +574,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -804,7 +804,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1017,7 +1017,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1035,7 +1035,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1053,7 +1053,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1466,7 +1466,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1480,13 +1480,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1518,13 +1518,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1546,7 +1546,7 @@ $$ ### oracle - + The oracle implementing a reflection about the bad state. @@ -1558,7 +1558,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1705,7 +1705,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1729,7 +1729,7 @@ $$ ### reflection\_qubits - + Reflection qubits, on which S0 is applied (if S0 is not user-specified). @@ -2601,7 +2601,7 @@ $$ ### state\_preparation - + The subcircuit implementing the A operator or Hadamards. **Return type** @@ -2902,7 +2902,7 @@ $$ ### zero\_reflection - + The subcircuit implementing the reflection about 0. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.mdx index 51a7c2399ba..f281bf88e40 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # qiskit.circuit.library.HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -221,7 +221,7 @@ $$ ### label - + Return gate label **Return type** @@ -247,7 +247,7 @@ $$ ### params - + return instruction params. @@ -359,7 +359,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.mdx index a1a80118c07..08dece610db 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # qiskit.circuit.library.HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1594,7 +1594,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.mdx index 00642ce66cc..9ee7a4ee743 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # qiskit.circuit.library.IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.mdx index c43d73fd54f..466a4892616 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # qiskit.circuit.library.IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.IQP ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.IQP ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.IQP ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.IQP ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.IQP ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.IQP ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.IQP ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.IQP ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.mdx index 36b3d2e12f5..228d63a8394 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # qiskit.circuit.library.InnerProduct - + An n\_qubit circuit that computes the inner product of two registers. Return a circuit to compute the inner product of 2 n-qubit registers. @@ -240,7 +240,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -399,7 +399,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -409,7 +409,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -445,19 +445,19 @@ python_api_name: qiskit.circuit.library.InnerProduct ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -675,7 +675,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### data - + Return the circuit data (instructions and context). **Returns** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -906,7 +906,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -924,7 +924,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### global\_phase - + Return the global phase of the circuit in radians. @@ -1337,7 +1337,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1351,13 +1351,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1389,13 +1389,13 @@ python_api_name: qiskit.circuit.library.InnerProduct ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1423,7 +1423,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1570,7 +1570,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.mdx index 778464735c1..aa0eece3ddc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # qiskit.circuit.library.IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on the parameter `geq`): @@ -247,7 +247,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -406,7 +406,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -416,7 +416,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -452,19 +452,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -682,7 +682,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -895,7 +895,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -913,7 +913,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -931,7 +931,7 @@ $$ ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -945,7 +945,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1358,7 +1358,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1372,19 +1372,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1416,7 +1416,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1426,13 +1426,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -1468,7 +1468,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1551,7 +1551,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1625,7 +1625,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2774,7 +2774,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 0e710afafb1..24f8be8422f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # qiskit.circuit.library.LinearAmplitudeFunction - + A circuit implementing a (piecewise) linear function on qubit amplitudes. An amplitude function $F$ of a function $f$ is a mapping @@ -282,7 +282,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -441,7 +441,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -451,7 +451,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -487,19 +487,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -717,7 +717,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1379,7 +1379,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1393,13 +1393,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,13 +1431,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1465,7 +1465,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1630,7 +1630,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.mdx index 530fedcf51e..a2b28bc967b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # qiskit.circuit.library.LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -927,7 +927,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -945,7 +945,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -963,7 +963,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,7 +1390,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1404,13 +1404,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1442,7 +1442,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1452,13 +1452,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1488,7 +1488,7 @@ $$ ### offset - + The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. @@ -1510,7 +1510,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1593,7 +1593,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1667,7 +1667,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2366,7 +2366,7 @@ $$ ### slope - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.mdx index 113e18bea04..a5b955a9b23 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # qiskit.circuit.library.LogNormalDistribution - + A circuit to encode a discretized log-normal distribution in qubit amplitudes. A random variable $X$ is log-normal distributed if @@ -281,7 +281,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -440,7 +440,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -450,7 +450,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -460,7 +460,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -496,19 +496,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -726,7 +726,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -939,7 +939,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1388,7 +1388,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1402,13 +1402,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1440,13 +1440,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1474,7 +1474,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1511,7 +1511,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1631,7 +1631,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2780,7 +2780,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.mdx index 23248f2b1df..f9db3cd5f14 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # qiskit.circuit.library.MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as: @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.library.MCMT ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.MCMT ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -467,19 +467,19 @@ python_api_name: qiskit.circuit.library.MCMT ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -679,7 +679,7 @@ python_api_name: qiskit.circuit.library.MCMT ### data - + Return the circuit data (instructions and context). **Returns** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -910,7 +910,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -928,7 +928,7 @@ python_api_name: qiskit.circuit.library.MCMT ### global\_phase - + Return the global phase of the circuit in radians. @@ -1301,7 +1301,7 @@ python_api_name: qiskit.circuit.library.MCMT ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1315,19 +1315,19 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_ancilla\_qubits - + Return the number of ancillas. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1359,13 +1359,13 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1393,7 +1393,7 @@ python_api_name: qiskit.circuit.library.MCMT ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1540,7 +1540,7 @@ python_api_name: qiskit.circuit.library.MCMT ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.mdx index fe1c79cf21e..30ab958d9f4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # qiskit.circuit.library.MCMTVChain - + The MCMT implementation using the CCX V-chain. This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -445,7 +445,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -455,7 +455,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -491,19 +491,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -703,7 +703,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### data - + Return the circuit data (instructions and context). **Returns** @@ -916,7 +916,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### global\_phase - + Return the global phase of the circuit in radians. @@ -1325,7 +1325,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1339,19 +1339,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_ancilla\_qubits - + Return the number of ancilla qubits required. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1383,13 +1383,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1417,7 +1417,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1564,7 +1564,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.mdx index 8ff6f6a2f0c..95094eee33f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # qiskit.circuit.library.MCPhaseGate - + Multi-controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the state of the control qubits. @@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -201,13 +201,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### duration - + Get the duration. @@ -235,7 +235,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### label - + Return gate label **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### params - + Get parameters from base\_gate. **Returns** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.mdx index 5f63d0f905d..197ad249388 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # qiskit.circuit.library.MCXGate - + The general, multi-controlled X gate. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.mdx index b59f372d7e8..71e449a2e93 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # qiskit.circuit.library.MCXGrayCode - + Implement the multi-controlled X gate using the Gray code. This delegates the implementation to the MCU1 gate, since $X = H \cdot U1(\pi) \cdot H$. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -228,7 +228,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### label - + Return gate label **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -268,13 +268,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### params - + Get parameters from base\_gate. **Returns** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.mdx index dc5130be5b3..81dd6bb49a5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # qiskit.circuit.library.MCXRecursive - + Implement the multi-controlled X gate using recursion. Using a single ancilla qubit, the multi-controlled X gate is recursively split onto four sub-registers. This is done until we reach the 3- or 4-controlled X gate since for these we have a concrete implementation that do not require ancillas. @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -186,13 +186,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -202,13 +202,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -266,13 +266,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### params - + Get parameters from base\_gate. **Returns** @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.mdx index 3df8b84511b..1c8afedd6c5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # qiskit.circuit.library.MCXVChain - + Implement the multi-controlled X gate using a V-chain of CX gates. Create new MCX gate. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### label - + Return gate label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -264,13 +264,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### params - + Get parameters from base\_gate. **Returns** @@ -408,7 +408,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.mdx index 5729c3ab6e5..240441ef2ea 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # qiskit.circuit.library.MSGate - + MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. Global Mølmer–Sørensen gate. @@ -179,19 +179,19 @@ python_api_name: qiskit.circuit.library.MSGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -225,7 +225,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return gate label **Return type** @@ -251,7 +251,7 @@ python_api_name: qiskit.circuit.library.MSGate ### params - + return instruction params. @@ -363,7 +363,7 @@ python_api_name: qiskit.circuit.library.MSGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.mdx index 9d3017dbe0b..afb38644b4e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # qiskit.circuit.library.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Measure ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.mdx index e7d6a250f20..06b7998c7cd 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # qiskit.circuit.library.NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -334,7 +334,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ python_api_name: qiskit.circuit.library.NLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ python_api_name: qiskit.circuit.library.NLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -874,7 +874,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.library.NLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1062,7 +1062,7 @@ python_api_name: qiskit.circuit.library.NLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1192,7 +1192,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1455,7 +1455,7 @@ python_api_name: qiskit.circuit.library.NLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1469,13 +1469,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1551,7 +1551,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1581,7 +1581,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1617,7 +1617,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1672,7 +1672,7 @@ python_api_name: qiskit.circuit.library.NLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1742,7 +1742,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1816,7 +1816,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1878,7 +1878,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1984,7 +1984,7 @@ python_api_name: qiskit.circuit.library.NLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.mdx index 7032973f7a3..e5a7a80789a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # qiskit.circuit.library.NormalDistribution - + A circuit to encode a discretized normal distribution in qubit amplitudes. The probability density function of the normal distribution is defined as @@ -329,7 +329,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -488,7 +488,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -498,7 +498,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -508,7 +508,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -544,19 +544,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -774,7 +774,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -987,7 +987,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1005,7 +1005,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1023,7 +1023,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1436,7 +1436,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1450,13 +1450,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1488,13 +1488,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1522,7 +1522,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1559,7 +1559,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1679,7 +1679,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2828,7 +2828,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.OR.mdx index c3b28bb31e6..6806bc6ef81 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # qiskit.circuit.library.OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -242,7 +242,7 @@ python_api_name: qiskit.circuit.library.OR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -401,7 +401,7 @@ python_api_name: qiskit.circuit.library.OR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -447,19 +447,19 @@ python_api_name: qiskit.circuit.library.OR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -677,7 +677,7 @@ python_api_name: qiskit.circuit.library.OR ### data - + Return the circuit data (instructions and context). **Returns** @@ -890,7 +890,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -908,7 +908,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -926,7 +926,7 @@ python_api_name: qiskit.circuit.library.OR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1339,7 +1339,7 @@ python_api_name: qiskit.circuit.library.OR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1353,13 +1353,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1391,13 +1391,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1425,7 +1425,7 @@ python_api_name: qiskit.circuit.library.OR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1572,7 +1572,7 @@ python_api_name: qiskit.circuit.library.OR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.mdx index 5c1be4004c0..bb5dae59d77 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # qiskit.circuit.library.PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -364,7 +364,7 @@ $$ ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -378,7 +378,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -461,7 +461,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -471,7 +471,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -507,19 +507,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -918,7 +918,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -932,7 +932,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -968,7 +968,7 @@ $$ ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -988,7 +988,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1006,7 +1006,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1068,7 +1068,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1116,7 +1116,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1246,7 +1246,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1509,7 +1509,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1523,13 +1523,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1553,7 +1553,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1575,7 +1575,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1585,13 +1585,13 @@ $$ ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1621,7 +1621,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1657,7 +1657,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1671,7 +1671,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1738,7 +1738,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1808,7 +1808,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1882,7 +1882,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1944,7 +1944,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2050,7 +2050,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.mdx index 5c9cefdd697..aa8f1da68ce 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # qiskit.circuit.library.PauliTwoDesign - + The Pauli Two-Design ansatz. This class implements a particular form of a 2-design circuit \[1], which is frequently studied in quantum machine learning literature, such as e.g. the investigating of Barren plateaus in variational algorithms \[2]. @@ -314,7 +314,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### data - + Return the circuit data (instructions and context). **Returns** @@ -854,7 +854,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement - + Get the entanglement strategy. **Return type** @@ -868,7 +868,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -914,7 +914,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### global\_phase - + Return the global phase of the circuit in radians. @@ -1022,7 +1022,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1152,7 +1152,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1429,13 +1429,13 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1459,7 +1459,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1491,7 +1491,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters\_settable - + Return the number of settable parameters. **Return type** @@ -1505,7 +1505,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1535,7 +1535,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1571,7 +1571,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1626,7 +1626,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1696,7 +1696,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qregs - + A list of the quantum registers associated with the circuit. @@ -1770,7 +1770,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1832,7 +1832,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1938,7 +1938,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.mdx index 52bab497dbe..27b23eec08e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # qiskit.circuit.library.Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.Permutation ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.Permutation ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.Permutation ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.Permutation ### data - + Return the circuit data (instructions and context). **Returns** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -940,7 +940,7 @@ python_api_name: qiskit.circuit.library.Permutation ### global\_phase - + Return the global phase of the circuit in radians. @@ -1353,7 +1353,7 @@ python_api_name: qiskit.circuit.library.Permutation ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1367,13 +1367,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1405,13 +1405,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1439,7 +1439,7 @@ python_api_name: qiskit.circuit.library.Permutation ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.Permutation ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.mdx index 4bfeba39fca..0a2f1467489 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # qiskit.circuit.library.PhaseEstimation - + Phase Estimation circuit. In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is @@ -268,7 +268,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -427,7 +427,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -437,7 +437,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -473,19 +473,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -703,7 +703,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -916,7 +916,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -934,7 +934,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1365,7 +1365,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1379,13 +1379,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1417,13 +1417,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1451,7 +1451,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1598,7 +1598,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.mdx index 70612ae3d38..60776a8b265 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # qiskit.circuit.library.PhaseGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -213,19 +213,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return gate label **Return type** @@ -269,7 +269,7 @@ $$ ### params - + return instruction params. @@ -381,7 +381,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.mdx index 96fe7cc233d..328bdf717af 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # qiskit.circuit.library.PhaseOracle - + Phase Oracle. The Phase Oracle object constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR). as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) & (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -407,7 +407,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -443,19 +443,19 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -972,7 +972,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### global\_phase - + Return the global phase of the circuit in radians. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1399,13 +1399,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1437,13 +1437,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1471,7 +1471,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1618,7 +1618,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.mdx index 95096181d9e..a31fd012fc2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # qiskit.circuit.library.PiecewiseChebyshev - + Piecewise Chebyshev approximation to an input function. For a given function $f(x)$ and degree $d$, this class implements a piecewise polynomial Chebyshev approximation on $n$ qubits to $f(x)$ on the given intervals. All the polynomials in the approximation are of degree $d$. @@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### breakpoints - + The breakpoints for the piecewise approximation. **Return type** @@ -438,7 +438,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### data - + Return the circuit data (instructions and context). **Returns** @@ -750,7 +750,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### degree - + The degree of the polynomials. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### f\_x - + The function to be approximated. **Return type** @@ -955,7 +955,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -973,7 +973,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -991,7 +991,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### global\_phase - + Return the global phase of the circuit in radians. @@ -1404,7 +1404,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1418,13 +1418,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1456,7 +1456,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1466,13 +1466,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1508,7 +1508,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1524,7 +1524,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### polynomials - + The polynomials for the piecewise approximation. **Return type** @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qregs - + A list of the quantum registers associated with the circuit. @@ -1679,7 +1679,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 02c49aaab34..bbdf82fb63e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # qiskit.circuit.library.PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -260,7 +260,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -393,7 +393,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -435,7 +435,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -447,7 +447,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -457,7 +457,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -493,19 +493,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -595,7 +595,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -737,7 +737,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -968,7 +968,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -986,7 +986,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1004,7 +1004,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1272,7 +1272,7 @@ $$ ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -1286,7 +1286,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -1445,7 +1445,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1459,19 +1459,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1503,7 +1503,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1513,13 +1513,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1549,7 +1549,7 @@ $$ ### offsets - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -1567,7 +1567,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1650,7 +1650,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1724,7 +1724,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2423,7 +2423,7 @@ $$ ### slopes - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 6aa4c1f6ddd..1baa9678c1b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # qiskit.circuit.library.PiecewisePolynomialPauliRotations - + Piecewise-polynomially-controlled Pauli rotations. This class implements a piecewise polynomial (not necessarily continuous) function, $f(x)$, on qubit amplitudes, which is defined through breakpoints and coefficients as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding coefficients by $[a_{j,1},...,a_{j,d}]$, where $d$ is the highest degree among all polynomials. @@ -303,7 +303,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -436,7 +436,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -478,7 +478,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise polynomial function. The function is polynomial in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -494,7 +494,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -504,7 +504,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -540,19 +540,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -564,7 +564,7 @@ $$ ### coeffs - + The coefficients of the polynomials. **Return type** @@ -656,7 +656,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -798,7 +798,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1029,7 +1029,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1047,7 +1047,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1065,7 +1065,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1333,7 +1333,7 @@ $$ ### mapped\_coeffs - + The coefficients mapped to the internal representation, since we only compare x>=breakpoint. **Return type** @@ -1492,7 +1492,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1506,7 +1506,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1520,13 +1520,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1558,7 +1558,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1568,13 +1568,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1610,7 +1610,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1693,7 +1693,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1767,7 +1767,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.mdx index c44c53cc017..0e5a1e22d3f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # qiskit.circuit.library.PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -263,7 +263,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -396,7 +396,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -508,7 +508,7 @@ $$ ### coeffs - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. @@ -730,7 +730,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -766,7 +766,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -993,7 +993,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1406,7 +1406,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1420,19 +1420,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1464,7 +1464,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1474,13 +1474,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1516,7 +1516,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1599,7 +1599,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1673,7 +1673,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1741,7 +1741,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.mdx index 9cc2e782cb0..e8e79d998fd 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # qiskit.circuit.library.QAOAAnsatz - + A generalized QAOA quantum circuit with a support of custom initial states and mixers. **References** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -403,7 +403,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -449,19 +449,19 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -593,7 +593,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cost\_operator - + Returns an operator representing the cost of the optimization problem. **Returns** @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### data - + Return the circuit data (instructions and context). **Returns** @@ -906,7 +906,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -924,7 +924,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -942,7 +942,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### global\_phase - + Return the global phase of the circuit in radians. @@ -990,7 +990,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### initial\_state - + Returns an optional initial state as a circuit **Return type** @@ -1365,7 +1365,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1373,7 +1373,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### mixer\_operator - + Returns an optional mixer operator expressed as an operator or a quantum circuit. **Returns** @@ -1393,13 +1393,13 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1431,7 +1431,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1441,7 +1441,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_qubits - + Return number of qubits. @@ -1469,7 +1469,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameter\_bounds - + Parameter bounds. **Returns: A list of pairs indicating the bounds, as (lower, upper). None indicates** @@ -1483,7 +1483,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1570,7 +1570,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qregs - + A list of the quantum registers associated with the circuit. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### reps - + Returns the reps parameter, which determines the depth of the circuit. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.mdx index 4d13f173c15..07900580f4a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # qiskit.circuit.library.QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -265,7 +265,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -296,7 +296,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -438,7 +438,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -448,7 +448,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -484,19 +484,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -714,7 +714,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -817,7 +817,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -941,7 +941,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -959,7 +959,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -977,7 +977,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1141,7 +1141,7 @@ $$ ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -1386,7 +1386,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1400,13 +1400,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1438,7 +1438,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1448,7 +1448,7 @@ $$ ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -1488,7 +1488,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1571,7 +1571,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1645,7 +1645,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.mdx index e3d7c5e8157..967422fd546 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # qiskit.circuit.library.QuadraticForm - + Implements a quadratic form on binary variables encoded in qubit registers. A quadratic form on binary variables is a quadratic function $Q$ acting on a binary variable of $n$ bits, $x = x_0 ... x_{n-1}$. For an integer matrix $A$, an integer vector $b$ and an integer $c$ the function can be written as @@ -269,7 +269,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -428,7 +428,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -438,7 +438,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -474,19 +474,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -704,7 +704,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -917,7 +917,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -953,7 +953,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1366,7 +1366,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1380,13 +1380,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1418,13 +1418,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1452,7 +1452,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1599,7 +1599,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1661,7 +1661,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.mdx index c22d099dc94..49dfa5cf997 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # qiskit.circuit.library.QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -409,7 +409,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -455,19 +455,19 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -685,7 +685,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### data - + Return the circuit data (instructions and context). **Returns** @@ -898,7 +898,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -916,7 +916,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### global\_phase - + Return the global phase of the circuit in radians. @@ -1347,7 +1347,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1361,13 +1361,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1399,13 +1399,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1433,7 +1433,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1580,7 +1580,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.mdx index ee957425994..a1e1aa5d622 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # qiskit.circuit.library.RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RC3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.mdx index fdcaf70dc5e..d08b8ae8071 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # qiskit.circuit.library.RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -177,19 +177,19 @@ python_api_name: qiskit.circuit.library.RCCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### params - + return instruction params. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.mdx index 95fa41f9b46..2e95ae4fee8 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # qiskit.circuit.library.RGate - + Rotation θ around the cos(φ)x + sin(φ)y axis. **Circuit symbol:** @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -223,7 +223,7 @@ $$ ### label - + Return gate label **Return type** @@ -249,7 +249,7 @@ $$ ### params - + return instruction params. @@ -361,7 +361,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.mdx index 4753fbf526a..724a8c3c5ab 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # qiskit.circuit.library.RVGate - + Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. **Circuit symbol:** @@ -207,19 +207,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -363,7 +363,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.mdx index 30836f4c33b..0adeaeab97d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # qiskit.circuit.library.RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.mdx index 05daf903c31..bb620977c24 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # qiskit.circuit.library.RXXGate - + A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.mdx index 3f32c8fabd2..a384f4039a6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # qiskit.circuit.library.RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return gate label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.mdx index d0ec9e70219..eb937897cb2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # qiskit.circuit.library.RYYGate - + A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -217,19 +217,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -247,7 +247,7 @@ $$ ### label - + Return gate label **Return type** @@ -273,7 +273,7 @@ $$ ### params - + return instruction params. @@ -385,7 +385,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.mdx index 524cbec7ead..e8f4b7c69a6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # qiskit.circuit.library.RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -231,7 +231,7 @@ $$ ### label - + Return gate label **Return type** @@ -257,7 +257,7 @@ $$ ### params - + return instruction params. @@ -369,7 +369,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.mdx index 33e46ce5819..488055eebb9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # qiskit.circuit.library.RZXGate - + A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. @@ -255,19 +255,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -285,7 +285,7 @@ $$ ### label - + Return gate label **Return type** @@ -311,7 +311,7 @@ $$ ### params - + return instruction params. @@ -423,7 +423,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.mdx index 41e21c373d6..0104ab8d23a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # qiskit.circuit.library.RZZGate - + A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -229,19 +229,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -259,7 +259,7 @@ $$ ### label - + Return gate label **Return type** @@ -285,7 +285,7 @@ $$ ### params - + return instruction params. @@ -397,7 +397,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.mdx index 601737c463b..3a5cb52dee9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # qiskit.circuit.library.RealAmplitudes - + The real-amplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. It is called `RealAmplitudes` since the prepared quantum states will only have real amplitudes, the complex part is always 0. @@ -359,7 +359,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -718,7 +718,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + Return the circuit data (instructions and context). **Returns** @@ -899,7 +899,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -913,7 +913,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -959,7 +959,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -977,7 +977,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1019,7 +1019,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### global\_phase - + Return the global phase of the circuit in radians. @@ -1067,7 +1067,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1197,7 +1197,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1460,7 +1460,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1474,13 +1474,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1504,7 +1504,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1536,7 +1536,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1556,7 +1556,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1586,7 +1586,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1622,7 +1622,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1636,7 +1636,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1677,7 +1677,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1747,7 +1747,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qregs - + A list of the quantum registers associated with the circuit. @@ -1821,7 +1821,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1883,7 +1883,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1989,7 +1989,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.mdx index e61eae070dd..1fa473d5474 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # qiskit.circuit.library.Reset - + Qubit reset. Create new reset instruction. @@ -107,19 +107,19 @@ python_api_name: qiskit.circuit.library.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.Reset ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.mdx index e681efc0e5d..20c11843bcc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # qiskit.circuit.library.SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.mdx index 31e2ca561e0..5e3e7644c3c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # qiskit.circuit.library.SXGate - + The single-qubit Sqrt(X) gate ($\sqrt{X}$). **Matrix Representation:** @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -230,7 +230,7 @@ $$ ### label - + Return gate label **Return type** @@ -256,7 +256,7 @@ $$ ### params - + return instruction params. @@ -368,7 +368,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.mdx index d2a244f6d0b..d07c7691d51 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # qiskit.circuit.library.SXdgGate - + The inverse single-qubit Sqrt(X) gate. $$ @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return gate label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.mdx index bbb9b3538d1..e55985c7c78 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # qiskit.circuit.library.SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.mdx index ee9a970ad95..2f3dfcb4adb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # qiskit.circuit.library.SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. @@ -199,19 +199,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -229,7 +229,7 @@ $$ ### label - + Return gate label **Return type** @@ -255,7 +255,7 @@ $$ ### params - + return instruction params. @@ -367,7 +367,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.mdx index 1a154ec3844..debdfc447aa 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # qiskit.circuit.library.TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.mdx index 3728c913051..b977e816f7a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # qiskit.circuit.library.TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return gate label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.mdx index 587fc587bad..9a56cc82014 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # qiskit.circuit.library.TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -381,7 +381,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -464,7 +464,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -474,7 +474,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -510,19 +510,19 @@ python_api_name: qiskit.circuit.library.TwoLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -740,7 +740,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -921,7 +921,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -981,7 +981,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1041,7 +1041,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1089,7 +1089,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1219,7 +1219,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1482,7 +1482,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1496,13 +1496,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1548,7 +1548,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1558,7 +1558,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1608,7 +1608,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1658,7 +1658,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1769,7 +1769,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1843,7 +1843,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1905,7 +1905,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2011,7 +2011,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.mdx index 1779ea7ff0e..974868d6f58 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # qiskit.circuit.library.U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -215,19 +215,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -245,7 +245,7 @@ $$ ### label - + Return gate label **Return type** @@ -271,7 +271,7 @@ $$ ### params - + return instruction params. @@ -383,7 +383,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.mdx index ec6ce49d431..f900cabbae9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # qiskit.circuit.library.U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return gate label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.mdx index 0988c3006d0..e1bd2b609fc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # qiskit.circuit.library.U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.mdx index 03bcceb0a06..3d48c7831a1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # qiskit.circuit.library.UGate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -204,19 +204,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -236,7 +236,7 @@ $$ ### label - + Return gate label **Return type** @@ -262,7 +262,7 @@ $$ ### params - + return instruction params. @@ -374,7 +374,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.mdx index ef7dc21df2f..c4e42d3304a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # qiskit.circuit.library.UniformDistribution - + A circuit to encode a discretized uniform distribution in qubit amplitudes. This simply corresponds to applying Hadamard gates on all qubits. @@ -254,7 +254,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -413,7 +413,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -423,7 +423,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -459,19 +459,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -938,7 +938,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1351,7 +1351,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1365,13 +1365,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1403,13 +1403,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1437,7 +1437,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.mdx index ee06a5dd981..1a7393acf4c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # qiskit.circuit.library.WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -280,7 +280,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -439,7 +439,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -449,7 +449,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -485,19 +485,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -715,7 +715,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -928,7 +928,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -964,7 +964,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1377,7 +1377,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1391,7 +1391,7 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. **Return type** @@ -1401,13 +1401,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_carry\_qubits - + The number of carry qubits required to compute the sum. Note that this is not necessarily equal to the number of ancilla qubits, these can be queried using `num_ancilla_qubits`. @@ -1423,7 +1423,7 @@ $$ ### num\_clbits - + Return number of classical bits. @@ -1447,7 +1447,7 @@ $$ ### num\_control\_qubits - + The number of additional control qubits required. Note that the total number of ancilla qubits can be obtained by calling the method `num_ancilla_qubits`. @@ -1471,7 +1471,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1481,13 +1481,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -1501,7 +1501,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -1537,7 +1537,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1620,7 +1620,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1694,7 +1694,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2843,7 +2843,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.mdx index 98d71f568f5..3484e52657d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # qiskit.circuit.library.XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.mdx index f99cf4a801a..b68b3b51374 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # qiskit.circuit.library.XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.XOR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.XOR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -457,19 +457,19 @@ python_api_name: qiskit.circuit.library.XOR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.XOR ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.XOR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1349,7 +1349,7 @@ python_api_name: qiskit.circuit.library.XOR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1363,13 +1363,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1401,13 +1401,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.library.XOR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.library.XOR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.mdx index 674193a1560..32233bb718d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # qiskit.circuit.library.YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.mdx index 69ab9d0a1c2..c871f0f71aa 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # qiskit.circuit.library.ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -439,7 +439,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -475,19 +475,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -705,7 +705,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -886,7 +886,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -936,7 +936,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -974,7 +974,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1036,7 +1036,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1084,7 +1084,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1214,7 +1214,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1491,13 +1491,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1543,7 +1543,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1553,13 +1553,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1589,7 +1589,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1625,7 +1625,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1639,7 +1639,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1667,7 +1667,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1706,7 +1706,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1776,7 +1776,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1850,7 +1850,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1912,7 +1912,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2018,7 +2018,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.mdx index ee60248a181..af04e29e3cb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # qiskit.circuit.library.ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return gate label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.mdx index c8fba9d090d..59624218b7a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # qiskit.circuit.library.ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -328,7 +328,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -471,19 +471,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -882,7 +882,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -896,7 +896,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -932,7 +932,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -970,7 +970,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1032,7 +1032,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1080,7 +1080,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1210,7 +1210,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1473,7 +1473,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1487,13 +1487,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1517,7 +1517,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1539,7 +1539,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1549,13 +1549,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1585,7 +1585,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1621,7 +1621,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1635,7 +1635,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1663,7 +1663,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1702,7 +1702,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1772,7 +1772,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1846,7 +1846,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1908,7 +1908,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2014,7 +2014,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.mdx index b1172f7de65..690f475c910 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # qiskit.circuit.library.iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. @@ -224,19 +224,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -270,7 +270,7 @@ $$ ### label - + Return gate label **Return type** @@ -296,7 +296,7 @@ $$ ### params - + return instruction params. @@ -408,7 +408,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.mdx index 3676f602c6f..c4c872cb726 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # qiskit.dagcircuit.DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. @@ -201,7 +201,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -344,7 +344,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** @@ -389,7 +389,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### global\_phase - + Return the global phase of the circuit. @@ -469,7 +469,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### node\_counter - + Returns the number of nodes in the dag. @@ -736,7 +736,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### wires - + Return a list of the wires in order. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.mdx index a27257781ea..2223f873a35 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.mdx index 7845dc568a1..e15c1b9546d 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # qiskit.dagcircuit.DAGDepNode - + Object to represent the information at a node in the DAGDependency(). It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -56,19 +56,19 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.mdx index 76f1d8958db..5c13d2d6885 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # qiskit.dagcircuit.DAGDependency - + Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed. @@ -114,7 +114,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -293,7 +293,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### global\_phase - + Return the global phase of the circuit. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.mdx index 37d16e30282..1345c274f80 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # qiskit.dagcircuit.DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -43,25 +43,25 @@ python_api_name: qiskit.dagcircuit.DAGNode ### condition - + Returns the condition of the node.op ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** @@ -82,7 +82,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### wire - + Returns the Bit object, else None. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.mdx index 9f0ca491d33..afc8f1ae8b3 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # qiskit.extensions.HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t @@ -208,19 +208,19 @@ python_api_name: qiskit.extensions.HamiltonianGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -238,7 +238,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return gate label **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### params - + return instruction params. @@ -380,7 +380,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.27/qiskit.extensions.Initialize.mdx index 65cdea9aaf6..f18e987a2ab 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.27/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # qiskit.extensions.Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers. Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. @@ -146,19 +146,19 @@ python_api_name: qiskit.extensions.Initialize ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ python_api_name: qiskit.extensions.Initialize ### params - + return instruction params. @@ -294,7 +294,7 @@ python_api_name: qiskit.extensions.Initialize ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.mdx index a27821f84ac..9a229bd9a2a 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # qiskit.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -163,7 +163,7 @@ python_api_name: qiskit.extensions.Snapshot ### label - + Return snapshot label @@ -185,7 +185,7 @@ python_api_name: qiskit.extensions.Snapshot ### params - + return instruction params. @@ -239,7 +239,7 @@ python_api_name: qiskit.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.mdx index 9dde9d4a6f5..f618d6b6234 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # qiskit.extensions.UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. @@ -207,19 +207,19 @@ python_api_name: qiskit.extensions.UnitaryGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return gate label **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### params - + return instruction params. @@ -379,7 +379,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.mdx index ec0d88deb2b..1fc4c51b85a 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index d7f67001b29..6eb9cad9b70 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # qiskit.finance.components.uncertainty\_problems.EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -151,7 +151,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 6fb62e94231..29664f6cbe0 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # qiskit.finance.components.uncertainty\_problems.EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -155,7 +155,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 9146304c8eb..743382d8479 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # qiskit.finance.components.uncertainty\_problems.FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. @@ -157,7 +157,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.mdx index b12af8df2e6..f94fc28a515 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # qiskit.finance.data\_providers.BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -17,7 +17,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -136,7 +136,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.mdx index fbf9b10dd1d..1c540f4e596 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # qiskit.finance.data\_providers.DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.mdx index 62a79450642..81ea451df61 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # qiskit.finance.data\_providers.ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.mdx index 4d9c5fbfb65..b204dd97849 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # qiskit.finance.data\_providers.RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type start: `datetime` :param start: first data point :type end: `datetime` :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.mdx index dd8223e6cd4..d15da364bae 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # qiskit.finance.data\_providers.StockMarket - + Stock Market enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 023b8271d31..e835736bd3a 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # qiskit.finance.data\_providers.WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.mdx index 7191e3eb1c2..6127b66fd16 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # qiskit.finance.data\_providers.YahooDataProvider - + Yahoo data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.mdx index f3d425d3b47..0fcf9661fcc 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # qiskit.ignis.characterization.AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.mdx index 81c6416d1a0..3895433f18f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # qiskit.ignis.characterization.AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 5cae1dd86fb..835a2557461 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # qiskit.ignis.characterization.AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.mdx index eff4166e29e..6da3dd6f598 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # qiskit.ignis.characterization.AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 3f7298c8cac..6c1f702e96d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # qiskit.ignis.characterization.BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.mdx index 67337efff90..e3b8343d1fc 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # qiskit.ignis.characterization.BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.mdx index c6d8618859b..96fea6f87d2 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # qiskit.ignis.characterization.DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.mdx index 451250e59f0..130ea82fb23 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # qiskit.ignis.characterization.RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ @@ -63,7 +63,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.mdx index f891073becd..c637555fae3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # qiskit.ignis.characterization.T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. @@ -75,7 +75,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -223,7 +223,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -233,7 +233,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.mdx index 48c153a777b..1b5f329eb5f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # qiskit.ignis.characterization.T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -176,7 +176,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -224,7 +224,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -234,7 +234,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.mdx index c32236e17fd..d3fed73eabd 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # qiskit.ignis.characterization.T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -242,7 +242,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -252,7 +252,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.mdx index 07adf6c7edb..ff69a1f4e7f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # qiskit.ignis.characterization.ZZFitter - + ZZ fitter ### \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.mdx index d9f7edb1ce8..19a3582b148 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # qiskit.ignis.logging.IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.mdx index 59417cb2165..b6e9c3ba0a3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # qiskit.ignis.logging.IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.mdx index 1fc8c56fc0e..1adb06a713e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # qiskit.ignis.logging.IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.mdx index 77dafde2131..5625ef587c9 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # qiskit.ignis.measurement.DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 231150bc93a..c3f15566789 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # qiskit.ignis.measurement.IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -85,19 +85,19 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### expected\_states - + Returns the expected states used to train the discriminator. ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. ### fitted - + True if the discriminator has been fitted to calibration data. @@ -236,7 +236,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 960417a844c..1cc340b8f18 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # qiskit.ignis.measurement.LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index deca26b8d9b..63dcc749e1b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # qiskit.ignis.measurement.QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index 3198ef0729f..bb38c72f3ac 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # qiskit.ignis.measurement.SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -99,7 +99,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index b32b4fedc2b..f3bdad81056 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # qiskit.ignis.mitigation.CTMPExpvalMeasMitigator - + N-qubit CTMP measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 2c346fc747f..41bc15188f2 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # qiskit.ignis.mitigation.CompleteExpvalMeasMitigator - + N-qubit measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index edb0220a002..311cfe9dff7 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # qiskit.ignis.mitigation.CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits @@ -69,13 +69,13 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### cal\_matrix - + Return cal\_matrix. ### filter - + Return a measurement filter using the cal matrix. @@ -92,7 +92,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### qubit\_list - + Return list of qubits. @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### state\_labels - + Return state\_labels. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index bba1c825c89..5d4e0fb721e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter - + Expectation value measurement error mitigator calibration fitter. See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter ### mitigator - + Return the fitted mitigator object diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.mdx index bad192ad4c9..4e49d3d9ca9 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # qiskit.ignis.mitigation.MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. @@ -87,13 +87,13 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter ### cal\_matrix - + Return cal\_matrix. ### state\_labels - + return the state label ordering of the cal matrix diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index 1bf39854ce1..2393eb6c6a4 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # qiskit.ignis.mitigation.TensoredExpvalMeasMitigator - + 1-qubit tensor product measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.mdx index e95839c22a7..4ea9dd389a6 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # qiskit.ignis.mitigation.TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### cal\_matrices - + Return cal\_matrices. @@ -132,19 +132,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### nqubits - + Return the number of qubits. See also MeasurementFilter.apply() ### qubit\_list\_sizes - + Return \_qubit\_list\_sizes. ### substate\_labels\_list - + Return \_substate\_labels\_list diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index d8f51cfe1c5..86f411e4057 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # qiskit.ignis.mitigation.TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. @@ -72,19 +72,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### cal\_matrices - + Return cal\_matrices. ### filter - + Return a measurement filter using the cal matrices. ### nqubits - + Return \_qubit\_list\_sizes. @@ -134,7 +134,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### substate\_labels\_list - + Return \_substate\_labels\_list. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.mdx index 1e10b61f70d..ab2a0651a33 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # qiskit.ignis.verification.AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.mdx index cd548abfdec..ff65a5b3863 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # qiskit.ignis.verification.AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.mdx index 2674216d626..dd4551bc7e5 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # qiskit.ignis.verification.BConfig - + This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.mdx index 84272747b04..942c0a7ad16 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # qiskit.ignis.verification.CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. **References** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -203,13 +203,13 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### key - + Return a string representation of a CNOT-dihedral object. ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -249,7 +249,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 53779d9ea3f..e17ccfa97fb 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # qiskit.ignis.verification.CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. @@ -88,19 +88,19 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### cliff\_lengths - + Return group elements lengths. ### fit - + Return fit as a 2 element list. ### fit\_cnotdihedral - + Return cnotdihedral fit parameters. @@ -158,43 +158,43 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### raw\_data - + Return raw\_data as 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_X - + Return the cnotdihedral X fitter. ### rbfit\_Z - + Return the cnotdihedral Z fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.mdx index bef77c48908..8c6b3996733 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # qiskit.ignis.verification.GatesetTomographyFitter - + Initialize gateset tomography fitter with experimental data. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.mdx index 9034971fc56..5a181f0ceab 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # qiskit.ignis.verification.GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.mdx index 18c3ddd3b1a..d0763c4eb6a 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # qiskit.ignis.verification.InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. @@ -92,13 +92,13 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit as a 2 element list. @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### fit\_int - + Return interleaved fit parameters. @@ -155,43 +155,43 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### raw\_data - + Return raw\_data as a 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_int - + Return the interleaved RB fitter. ### rbfit\_std - + Return the original RB fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.mdx index 5b2620265c2..58a4ad6472e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # qiskit.ignis.verification.Plotter - + Various plots of the ground state in MQC and PO experiments ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 4986354d75e..8efae59b513 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # qiskit.ignis.verification.ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### data - + Return tomography data @@ -146,13 +146,13 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.mdx index e158e83ebb6..034e74b0c4f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # qiskit.ignis.verification.PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -112,13 +112,13 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return the purity fit parameters. @@ -161,37 +161,37 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_pur - + Return the purity RB fitter. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.mdx index 155d27ff3fb..5cfe7c30e9d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # qiskit.ignis.verification.QVFitter - + Class for fitters for quantum volume. **Parameters** @@ -152,25 +152,25 @@ python_api_name: qiskit.ignis.verification.QVFitter ### depths - + Return depth list. ### heavy\_output\_counts - + Return the number of heavy output counts as measured. ### heavy\_output\_prob\_ideal - + Return the heavy output probability ideally. ### heavy\_outputs - + Return the ideal heavy outputs dictionary. @@ -254,7 +254,7 @@ python_api_name: qiskit.ignis.verification.QVFitter ### qubit\_lists - + Return depth list. @@ -274,13 +274,13 @@ python_api_name: qiskit.ignis.verification.QVFitter ### results - + Return all the results. ### ydata - + Return the average and std of the output probability. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.mdx index 685ea07071c..985a5a4a60a 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # qiskit.ignis.verification.RBFitter - + Class for fitters for randomized benchmarking. **Parameters** @@ -91,13 +91,13 @@ python_api_name: qiskit.ignis.verification.RBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit. @@ -151,31 +151,31 @@ python_api_name: qiskit.ignis.verification.RBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.mdx index 8e0aa13fe2f..c6f3feb5f1d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # qiskit.ignis.verification.RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.mdx index 40c093860dc..4b648fd4806 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # qiskit.ignis.verification.StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### data - + Return tomography data @@ -134,13 +134,13 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.mdx index 210024aa6c3..e726f44185c 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # qiskit.ignis.verification.TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### data - + Return tomography data @@ -139,13 +139,13 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.mdx index fb4bc677a25..7ef1a0f56b0 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # qiskit.ml.circuit.library.RawFeatureVector - + The raw feature vector circuit. This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. @@ -262,7 +262,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -311,7 +311,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -321,7 +321,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -357,19 +357,19 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -587,7 +587,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### data - + Return the circuit data (instructions and context). **Returns** @@ -794,7 +794,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### feature\_dimension - + Return the feature dimension. **Return type** @@ -814,7 +814,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -832,7 +832,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -850,7 +850,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### global\_phase - + Return the global phase of the circuit in radians. @@ -1263,7 +1263,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1277,13 +1277,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1315,7 +1315,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1325,7 +1325,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1355,7 +1355,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ordered\_parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1375,7 +1375,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1462,7 +1462,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qregs - + A list of the quantum registers associated with the circuit. @@ -1536,7 +1536,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.mdx index c4c9377bab4..b77a9f68a00 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # qiskit.opflow\.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms. @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -152,7 +152,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -190,7 +190,7 @@ python_api_name: qiskit.opflow.OperatorBase ### instance\_id - + Return the unique instance id. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -232,7 +232,7 @@ python_api_name: qiskit.opflow.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -246,13 +246,13 @@ python_api_name: qiskit.opflow.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -274,7 +274,7 @@ python_api_name: qiskit.opflow.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -338,7 +338,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.mdx index ba7506b1ae2..6c84da9a7c5 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.mdx index 189f13d6312..30793bcabc2 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # qiskit.opflow\.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.mdx index cac7b4701f0..2cb65167d0d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # qiskit.opflow\.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -91,7 +91,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.mdx index ca78c680dc6..0a8236f3414 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: 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. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.mdx index 68aa401408c..c101a7e72fc 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # qiskit.opflow\.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.mdx index b0a4339ac41..2a88b2e95df 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # qiskit.opflow\.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.mdx index ca5f23f44a6..1149c7de676 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # qiskit.opflow\.converters.TwoQubitReduction - + Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.mdx index fb6942b9eac..319fad60d56 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # qiskit.opflow\.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.mdx index 3015e63ad6d..4307ba9028e 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # qiskit.opflow\.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.mdx index 343c2ba7f2c..f7a8b7072f4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # qiskit.opflow\.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -339,7 +339,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.mdx index 5c1c0bb0633..37584d0b1a9 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: 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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 86fb846cda4..802993f8c7e 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # qiskit.opflow\.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.mdx index 973696c8101..d4e2334de57 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # qiskit.opflow\.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.mdx index c5d621e5685..45182a39450 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # qiskit.opflow\.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.mdx index 5e3589b216d..67b0c31e2c4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # qiskit.opflow\.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.mdx index 8f8d35f2176..8e93902e7f4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # qiskit.opflow\.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 77e79b9b50f..13706eb8d80 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # qiskit.opflow\.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.mdx index 0949a77d78f..ecdca70e797 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # qiskit.opflow\.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.mdx index bddf7d66280..f0c270cb8d2 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # qiskit.opflow\.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.mdx index 87d88b0445c..20138e0222c 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # qiskit.opflow\.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.mdx index 52ab8fcb878..c8a8c0bed3d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # qiskit.opflow\.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.mdx index a348a6f16a6..4db723e487f 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # qiskit.opflow\.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.mdx index fe0b5c9a89a..50f40847244 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # qiskit.opflow\.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.mdx index 17c9d23cd68..afc869f6803 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # qiskit.opflow\.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.mdx index b3eb5b129e4..1755df95faa 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # qiskit.opflow\.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.mdx index a62cbcf624c..6e0d6fa835c 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # qiskit.opflow\.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.mdx index d05da2b585d..b187e1a419f 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # qiskit.opflow\.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.mdx index bbeb6738ac6..e38607f9e2f 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # qiskit.opflow\.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.mdx index 2970f50da08..45700a4921e 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # qiskit.opflow\.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.mdx index 8ceb0bef3f3..26d09c88ce8 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # qiskit.opflow\.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.mdx index c5d80b1cf27..180e522737c 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # qiskit.opflow\.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -147,7 +147,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.mdx index 891b8ba0d34..5cdd4ea3e1c 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # qiskit.opflow\.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parameterized quantum state, where QFI is: @@ -97,7 +97,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -116,7 +116,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.mdx index 1671ffe435a..4835ceb5234 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # qiskit.opflow\.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.mdx index d974f06623f..1321ff3a1e0 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # qiskit.opflow\.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -358,7 +358,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.mdx index f721205a1dd..c8a771aaffa 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # qiskit.opflow\.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -88,7 +88,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### instance\_id - + Return the unique instance id. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -384,7 +384,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.mdx index 918ec65c28a..b5691decef7 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # qiskit.opflow\.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -392,7 +392,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.mdx index ca947fa5de4..e4935df5787 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # qiskit.opflow\.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### instance\_id - + Return the unique instance id. **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -357,7 +357,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.mdx index 988ed0b4d73..f8475d2ed87 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # qiskit.opflow\.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -345,7 +345,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.mdx index 1b0a78fbd83..36bb26febc4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # qiskit.opflow\.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -237,7 +237,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### instance\_id - + Return the unique instance id. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -349,7 +349,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.mdx index efc160b9f97..fa9f4240cb7 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # qiskit.opflow\.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### instance\_id - + Return the unique instance id. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -301,7 +301,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 3db92a8dca2..d46c8e87812 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # qiskit.opflow\.primitive\_ops.PauliSumOp - + Class for Operators backend by Terra’s `SparsePauliOp` class. **Parameters** @@ -144,7 +144,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -248,7 +248,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -423,7 +423,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 1a9e11ea32b..a8370c8dbbd 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # qiskit.opflow\.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### instance\_id - + Return the unique instance id. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -341,7 +341,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 331c1a2773d..ccc36bd63f4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # qiskit.opflow\.primitive\_ops.TaperedPauliSumOp - + Class for PauliSumOp after tapering **Parameters** @@ -145,7 +145,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -249,7 +249,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -268,7 +268,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -424,7 +424,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -593,7 +593,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### z2\_symmetries - + Z2 symmetries which the Operator has. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 9a03fe2796a..59e45423a36 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # qiskit.opflow\.primitive\_ops.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian. @@ -94,7 +94,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -114,19 +114,19 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -154,7 +154,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### tapering\_values - + returns tapering values diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.mdx index a777edec949..f29696eb867 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # qiskit.opflow\.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -166,7 +166,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### instance\_id - + Return the unique instance id. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -429,7 +429,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.mdx index 59b7bac50bc..a67e73011a8 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # qiskit.opflow\.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -260,7 +260,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -368,7 +368,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.mdx index 495815205a6..e8c4153425d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # qiskit.opflow\.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -139,7 +139,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -329,7 +329,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.mdx index 7a59f2bec8c..70c79967b23 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # qiskit.opflow\.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index a87bee5dd45..f4b12c18f38 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # qiskit.opflow\.state\_fns.SparseVectorStateFn - + A class for sparse state functions and measurements in vector representation. This class uses `scipy.sparse.spmatrix` for the internal representation. @@ -143,7 +143,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -333,7 +333,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.mdx index e59a578cbd1..8dfd3d675cd 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # qiskit.opflow\.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -270,7 +270,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -326,7 +326,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.mdx index 39840549f68..5d7b4797e1b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # qiskit.opflow\.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.mdx index 57f4848eb03..cf80f51af66 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.mdx index c6a662e3b43..a7214bb57c2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # qiskit.optimization.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 2a05542589f..fac5d6db3ec 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # qiskit.optimization.algorithms.ADMMOptimizationResult - + ADMMOptimization Result. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### state - + returns state **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.mdx index ce8fa022986..aab119a9138 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # qiskit.optimization.algorithms.ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer ### parameters - + Returns current parameters of the optimizer. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.mdx index f0389705c6e..90db1cd91a2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # qiskit.optimization.algorithms.ADMMParameters - + Defines a set of parameters for ADMM optimizer. Defines parameters for ADMM optimizer and their default values. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.mdx index 4595f865b33..6614f4c70e0 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # qiskit.optimization.algorithms.ADMMState - + Internal computation state of the ADMM implementation. The state keeps track of various variables are stored that are being updated during problem solving. The values are relevant to the problem being solved. The state is recreated for each optimization problem. State is returned as the third value. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 6e923b0ccd7..c004ba4e818 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # qiskit.optimization.algorithms.CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.mdx index 706d15875e5..69931748b27 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # qiskit.optimization.algorithms.CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index e9ec74f18af..034e93e4f26 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # qiskit.optimization.algorithms.GroverOptimizationResult - + A result object for Grover Optimization methods. Constructs a result object with the specific Grover properties. @@ -69,7 +69,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### intermediate\_fval - + Getter of the intermediate fval **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_input\_qubits - + Getter of n\_input\_qubits **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_output\_qubits - + Getter of n\_output\_qubits **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### operation\_counts - + Get the operation counts. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### threshold - + Getter of the threshold of Grover algorithm. **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.mdx index 7cf743a4f1a..c74c9b56268 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # qiskit.optimization.algorithms.GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer ### quantum\_instance - + The quantum instance to run the circuits. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.mdx index 6b7fed092a7..707027da784 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # qiskit.optimization.algorithms.IntermediateResult - + Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 5f41710e8c8..94a19c249b8 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # qiskit.optimization.algorithms.MinimumEigenOptimizationResult - + Minimum Eigen Optimizer Result. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### min\_eigen\_solver\_result - + Returns a result object obtained from the instance of `MinimumEigensolver`. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_samples - + Returns the list of raw solution samples of `MinimumEigensolver`. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index ad5c27f7431..c85991d6206 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # qiskit.optimization.algorithms.MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer ### min\_eigen\_solver - + Returns the minimum eigensolver. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 990cb906264..46f8728fbc6 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # qiskit.optimization.algorithms.MultiStartOptimizer - + An abstract class that implements multi start optimization and should be sub-classed by other optimizers. Constructs an instance of this optimizer. @@ -48,7 +48,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index be4e56a9955..7c401461d24 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # qiskit.optimization.algorithms.OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.mdx index ae2b033deed..8094132f7ed 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # qiskit.optimization.algorithms.OptimizationResult - + A base class for optimization results. The optimization algorithms return an object of the type `OptimizationResult` with the information about the solution obtained. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index a0eff974aad..3c3dc40eb73 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # qiskit.optimization.algorithms.OptimizationResultStatus - + Termination status of an optimization algorithm. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 759447cef02..674ed729cf0 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult - + Recursive Eigen Optimizer Result. Constructs an instance of the result class. @@ -60,7 +60,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### fval - + Returns the optimal function value. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### history - + Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### replacements - + Returns a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### samples - + Returns the list of solution samples **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index af82acf3b40..3e8a9033c99 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index bbede36b2c3..eac72c40a44 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # qiskit.optimization.algorithms.SlsqpOptimizationResult - + SLSQP optimization result, defines additional properties that may be returned by the optimizer. Constructs a result object with properties specific to SLSQP. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fx - + Returns the final value of the objective function being actually optimized. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### imode - + Returns the exit mode from the optimizer. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### its - + Returns the number of iterations **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -126,7 +126,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### smode - + Returns message describing the exit mode from the optimizer. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index e164c53a9ed..f7bc6a8894e 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # qiskit.optimization.algorithms.SlsqpOptimizer - + The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.mdx index 4396d597a6f..1c4fdf310cb 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # qiskit.optimization.algorithms.SolutionSample - + A sample of an optimization solution ### x diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx index 92d3d3d31f2..7eb8cf5d8d2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx @@ -32,12 +32,12 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord - + Alias for field number 2 @@ -49,7 +49,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### dim - + Alias for field number 1 @@ -63,13 +63,13 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### name - + Alias for field number 0 #### w - + Alias for field number 3 diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.mdx index 773b2b14e50..aa541790e65 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # qiskit.optimization.converters.InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality ### mode - + Returns the mode of the converter **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.mdx index 781285ebc33..a784e593b16 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # qiskit.optimization.converters.IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index 613aef79e7f..6b00cbc52a9 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # qiskit.optimization.converters.LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. **Parameters** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 8e9d417f504..f9144290aa3 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # qiskit.optimization.converters.QuadraticProgramConverter - + An abstract class for converters of quadratic programs in Qiskit’s optimization module. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index afbfbf0c222..654306d442b 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # qiskit.optimization.converters.QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.mdx index cacfebafefa..198e25adc32 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # qiskit.optimization.problems.Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -57,7 +57,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.mdx index c6cade6be8f..8012335c854 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # qiskit.optimization.problems.LinearConstraint - + Representation of a linear constraint. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.mdx index 17f8b1b328d..b94cbc7d5eb 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # qiskit.optimization.problems.LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.mdx index 51854c923bc..ff30982abce 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # qiskit.optimization.problems.QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. @@ -81,7 +81,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.mdx index 6bf0a82b458..fb9d9b18740 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # qiskit.optimization.problems.QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.mdx index ccd36875b0e..065d86bfc4d 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # qiskit.optimization.problems.QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### sense - + Returns the sense of the objective function. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.mdx index 2b72e18387b..a0c1ca22a8e 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # qiskit.optimization.problems.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.mdx index fce41233579..2ed7c5c3895 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # qiskit.optimization.problems.QuadraticProgramElement - + Interface class for all objects that have a parent QuadraticProgram. Initialize object with parent QuadraticProgram. @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.mdx index 9b632a061b3..714b11e33fb 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # qiskit.optimization.problems.Variable - + Representation of a variable. Creates a new Variable. @@ -86,7 +86,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.27/qiskit.providers.Backend.mdx index 4c622d7d5d0..275990c1ea9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # qiskit.providers.Backend - + Base common type for all versioned Backend abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.mdx index 0f3f01bf612..a7b87eb321a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.27/qiskit.providers.BackendV1.mdx index e29d93917b7..424be0b0406 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # qiskit.providers.BackendV1 - + Abstract class for Backends This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.BackendV1 ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. @@ -129,7 +129,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.mdx index 69b37a70800..16e3917607f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # qiskit.providers.BaseBackend - + Legacy Base class for backends. Base class for backends. @@ -26,7 +26,7 @@ python_api_name: qiskit.providers.BaseBackend ### \_\_init\_\_ - + Base class for backends. This method should initialize the module and its configuration, and raise an exception if a component of the module is not available. @@ -112,7 +112,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.BaseJob.mdx index 9a1e3bf93e2..b541b35b6da 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # qiskit.providers.BaseJob - + Legacy Class to handle asynchronous jobs Initializes the asynchronous job. @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -104,7 +104,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -120,13 +120,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.mdx index f98913d12c2..6375f151453 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # qiskit.providers.BaseProvider - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.Job.mdx b/docs/api/qiskit/0.27/qiskit.providers.Job.mdx index 1d10a1b77b7..cda7319d030 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # qiskit.providers.Job - + Base common type for all versioned Job abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.27/qiskit.providers.JobError.mdx index 3eb1b427e63..d3a30520088 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.27/qiskit.providers.JobStatus.mdx index e67e057e5fb..4fb1308aaae 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # qiskit.providers.JobStatus - + Class for job status enumerated type. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.mdx index 3b92d060cc1..a1d801b683e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.27/qiskit.providers.JobV1.mdx index d749faf9bc1..1231d7a0949 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # qiskit.providers.JobV1 - + Class to handle jobs This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -130,13 +130,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.27/qiskit.providers.Options.mdx b/docs/api/qiskit/0.27/qiskit.providers.Options.mdx index 1572b839c81..46b37d5e605 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # qiskit.providers.Options - + Base options object This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. diff --git a/docs/api/qiskit/0.27/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.27/qiskit.providers.Provider.mdx index 77cb7c78f67..70ba4705dc6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # qiskit.providers.Provider - + Base common type for all versioned Provider abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.mdx index 87199668b9c..399803c6bc9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # qiskit.providers.ProviderV1 - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.mdx index 8b4c8b210ef..131f42829eb 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.mdx index 5f19e6662bc..db6c76b8924 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.mdx index 7d436aa2dcd..276c34ed48b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # qiskit.providers.aer.AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.mdx index 4cc9bbc4687..c52b9c43fea 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # qiskit.providers.aer.AerProvider - + Provider for Qiskit Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.mdx index 894385f2b2c..5166e47fa6b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # qiskit.providers.aer.AerSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.mdx index df0ca228569..70031ecd02c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # qiskit.providers.aer.PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.mdx index 43e90230390..5eae2e7dda2 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # qiskit.providers.aer.QasmSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.mdx index 9eb2cb364c1..6baabe9c159 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # qiskit.providers.aer.StatevectorSimulator - + Ideal quantum circuit statevector simulator **Configurable Options** @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.mdx index a6675a75b9b..0868ccf5ad1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # qiskit.providers.aer.UnitarySimulator - + Ideal quantum circuit unitary simulator. **Configurable Options** @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.mdx index 124d02898e9..420ac5f091c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # qiskit.providers.aer.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -134,25 +134,25 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### label - + Return snapshot label @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### params - + return instruction params. @@ -246,7 +246,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 306c587679e..c0b66fdaddb 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # qiskit.providers.aer.extensions.SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -136,25 +136,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### label - + Return snapshot label @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### params - + return instruction params. @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### snapshot\_type - + Return snapshot type @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index efd3dc2dfd0..beef7a5cb88 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # qiskit.providers.aer.extensions.SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create an expectation value snapshot instruction. @@ -140,25 +140,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### label - + Return snapshot label @@ -198,7 +198,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### snapshot\_type - + Return snapshot type @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index d95040a3569..42a19cf77cf 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # qiskit.providers.aer.extensions.SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -138,25 +138,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### label - + Return snapshot label @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### params - + return instruction params. @@ -250,7 +250,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### snapshot\_type - + Return snapshot type @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index cce75df839f..5513c400507 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # qiskit.providers.aer.extensions.SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index aaf94825caa..da85a096971 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # qiskit.providers.aer.extensions.SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.mdx index be073927071..b7328f95935 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # qiskit.providers.aer.library.SaveAmplitudes - + Save complex statevector amplitudes. Instruction to save complex statevector amplitudes. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### params - + return instruction params. @@ -249,7 +249,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 44d7c004322..f89b8934cc0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # qiskit.providers.aer.library.SaveAmplitudesSquared - + Save squared statevector amplitudes (probabilities). Instruction to save squared statevector amplitudes (probabilities). @@ -133,19 +133,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -179,7 +179,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### params - + return instruction params. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.mdx index a24504ca663..6e7ba54dc69 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # qiskit.providers.aer.library.SaveDensityMatrix - + Save a reduced density matrix. Create new instruction to save the simulator reduced density matrix. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.mdx index 7926573f78c..771933d3012 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # qiskit.providers.aer.library.SaveExpectationValue - + Save expectation value of an operator. Instruction to save the expectation value of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 5efb040e989..09aa0bbf8c8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # qiskit.providers.aer.library.SaveExpectationValueVariance - + Save expectation value and variance of an operator. Instruction to save the expectation value and variance of a Hermitian operator. @@ -143,19 +143,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### params - + return instruction params. @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.mdx index cb0c6d71c32..935ff83b4e6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # qiskit.providers.aer.library.SaveMatrixProductState - + Save matrix product state instruction Create new instruction to save the matrix product state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.mdx index f249fef282a..c3ea4d78da5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # qiskit.providers.aer.library.SaveProbabilities - + Save measurement outcome probabilities vector. Instruction to save measurement probabilities vector. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index a2b8dd8d06a..efee5fd5d58 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # qiskit.providers.aer.library.SaveProbabilitiesDict - + Save measurement outcome probabilities dict. Instruction to save measurement probabilities dict. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### params - + return instruction params. @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.mdx index 2ddab3d3703..532448045c1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # qiskit.providers.aer.library.SaveStabilizer - + Save Stabilizer instruction Create new instruction to save the stabilizer simulator state. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.mdx index 1f88f4e933e..55ce2af7211 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # qiskit.providers.aer.library.SaveState - + Save simulator state The format of the saved state depends on the simulation method used. @@ -135,19 +135,19 @@ python_api_name: qiskit.providers.aer.library.SaveState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -181,7 +181,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### params - + return instruction params. @@ -253,7 +253,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.mdx index 5bf9d2df3e9..89e96cdc9bb 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # qiskit.providers.aer.library.SaveStatevector - + Save statevector Create new instruction to save the simulator statevector. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 6e3c47d75e9..9030afc159d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # qiskit.providers.aer.library.SaveStatevectorDict - + Save statevector as ket-form dictionary. Create new instruction to save the simulator statevector as a dict. @@ -129,19 +129,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### params - + return instruction params. @@ -247,7 +247,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.mdx index b4c232ab8ba..d1327e1b14c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # qiskit.providers.aer.library.SaveSuperOp - + Save a SuperOp matrix. Create new instruction to save the superop simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.mdx index 3c482c9b6df..5017a57359c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # qiskit.providers.aer.library.SaveUnitary - + Save Unitary Create new instruction to save the unitary simulator state. @@ -127,19 +127,19 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -173,7 +173,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### params - + return instruction params. @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.mdx index 46e70a5b43a..c3c2c6bb8c7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # qiskit.providers.aer.library.SetDensityMatrix - + Set density matrix state of the simulator Create new instruction to set the density matrix state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.mdx index ccbc1addb72..ec56b616cd3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # qiskit.providers.aer.library.SetMatrixProductState - + Set the matrix product state of the simulator Create new instruction to set the matrix product state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.mdx index ba27f19829a..ffc5da2cab4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # qiskit.providers.aer.library.SetStabilizer - + Set the Clifford stabilizer state of the simulator Create new instruction to set the Clifford stabilizer state of the simulator. @@ -123,19 +123,19 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -185,7 +185,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### params - + return instruction params. @@ -257,7 +257,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.mdx index 2ac69a2626d..491db2db87c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # qiskit.providers.aer.library.SetStatevector - + Set the statevector state of the simulator Create new instruction to set the statevector state of the simulator. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.mdx index fef264d4699..28f49f0dbe7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # qiskit.providers.aer.library.SetSuperOp - + Set superop state of the simulator Create new instruction to set the superop simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.mdx index 13bf5ced8e3..5c2c3d28e7a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # qiskit.providers.aer.library.SetUnitary - + Set unitary state of the simulator Create new instruction to set the unitary simulator state. @@ -131,19 +131,19 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### params - + return instruction params. @@ -265,7 +265,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.mdx index 0dc4d932729..34f9b3eb09b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # qiskit.providers.aer.noise.NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -211,13 +211,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### basis\_gates - + Return basis\_gates for compiling to the noise model. ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -279,7 +279,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** @@ -307,13 +307,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### noise\_instructions - + Return the set of noisy instructions for this noise model. ### noise\_qubits - + Return the set of noisy qubits for this noise model. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.mdx index 74b55875e7f..baf24e9adea 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # qiskit.providers.aer.noise.QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -113,13 +113,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### atol - + The default absolute tolerance parameter for float comparisons. ### circuits - + Return the list of error circuits. @@ -231,7 +231,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -259,31 +259,31 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### probabilities - + Return the list of error probabilities. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. ### size - + Return the number of error circuit. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.mdx index 5ade73205a5..c80abb84bb6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # qiskit.providers.aer.noise.ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -105,7 +105,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### atol - + The default absolute tolerance parameter for float comparisons. @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -222,25 +222,25 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### probabilities - + Return the readout error probabilities matrix. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 36fd9160769..2bbe1550693 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # qiskit.providers.aer.pulse.PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.mdx index 614c2a792a2..0fa61f4fa8b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # qiskit.providers.aer.utils.NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ### \_\_init\_\_ @@ -74,7 +74,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -107,13 +107,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -188,7 +188,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.mdx index b2484d426e2..12be712f6d5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.mdx index b63b6e3b53e..0b5583d413b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # qiskit.providers.basicaer.BasicAerJob - + BasicAerJob class. Initializes the asynchronous job. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.mdx index c1939d01626..7d4a7713428 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # qiskit.providers.basicaer.BasicAerProvider - + Provider for Basic Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 812266ea5a5..3223ff61ecb 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # qiskit.providers.basicaer.QasmSimulatorPy - + Python implementation of a qasm simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index e7b59279ebc..e830fe662f3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # qiskit.providers.basicaer.StatevectorSimulatorPy - + Python statevector simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 9ca017e38d9..d995e3d1ea7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # qiskit.providers.basicaer.UnitarySimulatorPy - + Python implementation of a unitary simulator. Initialize a backend class @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.mdx index eed497b098b..0c252dfe2f7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # qiskit.providers.ibmq.AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### backend - + Return the backend service. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### experiment - + Return the experiment service. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### random - + Return the random number service. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### runtime - + Return the runtime service. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.mdx index a42f6fcc7f0..50c159e6f5a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # qiskit.providers.ibmq.BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 0534a43e692..875e82950fe 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index a4ec83c34e6..6c9a297024b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index f717adfe0ab..b136d6adeb0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 33c648800fe..5ce0ebbf7fe 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.mdx index 580269b5dc1..4c43ba525ff 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index b6c35dbb581..9827bacb02a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.mdx index 53d6fb24933..36a6392a8c5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # qiskit.providers.ibmq.IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -266,7 +266,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 0f1ec653264..9e7cbedf243 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 6c528a208d9..c41b6198506 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.mdx index 3261aa33e93..7c48db09351 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.mdx index 76c57f34d1e..9aadfa1571b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # qiskit.providers.ibmq.IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 45671612a35..3e8e4221c52 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.mdx index d9a06327886..4d2c232562c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.mdx index 08f35876194..edef556508c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # qiskit.providers.ibmq.IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.mdx index a9a85d7ec5b..9a526bf7c47 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.mdx index d593ae2b0dd..0b4ad9205f6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # qiskit.providers.ibmq.RunnerResult - + Result class for Qiskit Runtime program circuit-runner. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.mdx index 8291fee577b..552863281e9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # qiskit.providers.ibmq.credentials.Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.mdx index abfa163eeb0..95afc72b8e9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 7b9f5182624..ca02ff40b71 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index a9e62b5535c..0ca3284f507 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.mdx index cfd582127ea..6128a7eef20 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult # qiskit.providers.ibmq.experiment.AnalysisResult - + Class representing an analysis result for an experiment. AnalysisResult constructor. @@ -72,7 +72,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### quality - + Return the analysis result quality. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### uuid - + Return UUID of this analysis result. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.mdx index 7427458a124..fdb72ef26ed 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment # qiskit.providers.ibmq.experiment.Experiment - + Class representing an experiment. Experiment constructor. @@ -140,7 +140,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### analysis\_results - + Return analysis results associated with this experiment. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### backend\_name - + Return the experiment’s backend name. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### end\_datetime - + Return the timestamp when the experiment ended. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -199,7 +199,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### group - + Return the experiment’s group. **Return type** @@ -209,7 +209,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### hub - + Return the experiment’s hub. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### owner - + Return the experiment’s owner. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### plot\_names - + Return names of plots associated with this experiment. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### project - + Return the experiment’s project. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### share\_level - + Return the experiment share\_level. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### start\_datetime - + Return the timestamp when the experiment started. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### uuid - + Return the experiment’s uuid. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.mdx index 7cc9ba67464..9e99472cbd9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService # qiskit.providers.ibmq.experiment.ExperimentService - + Provides experiment related services. This class is the main interface to invoke IBM Quantum Experience experiment services, which allow you to create, delete, update, query, and retrieve experiments, experiment plots, and analysis results. The `experiment` attribute of `AccountProvider` is an instance of this class, and the main syntax for using the services is `provider.experiment.`. For example: diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.mdx index a84182c8093..297953cbc9e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # qiskit.providers.ibmq.job.IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### experiment\_id - + Return the experiment ID. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 8c434eb6a8d..16bd976025f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.mdx index 05b07ab9e1e..d147091a499 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index b231d0ca95b..d0d47ad0384 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index c23cb5e52fb..144b7e914df 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 8d9510d9aac..fc87ed7e3af 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.mdx index eef6d90d4f1..1633ac1d3d3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # qiskit.providers.ibmq.job.QueueInfo - + Queue information for a job. QueueInfo constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 35bd0a28da1..709c72eed27 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # qiskit.providers.ibmq.managed.IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index f2a7aeec415..7411d99dcd2 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 6c798037ba1..a0d5b3168e8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index eb767a0a686..bd20ae91014 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index c747eba6ca5..52cbd84543b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 98dd2ef2d2c..914c24905b5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 7cbee5eac87..8ae8104eb37 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.mdx index bf27feda105..56a0866e66b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # qiskit.providers.ibmq.managed.ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 3a5021e5dad..cc13cad9a64 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # qiskit.providers.ibmq.managed.ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.mdx index 92c87844d69..7589eb0acd3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # qiskit.providers.ibmq.managed.ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.mdx index ad17f120b86..694860cb540 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # qiskit.providers.ibmq.random.CQCExtractor - + Class for interfacing with a CQC remote extractor. There are two extractor methods - Dodis (extractor 1) and Hayashi (extractor 2). These methods can be invoked synchronously or asynchronously. To invoke them synchronously: diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index b769ead73c1..20098813421 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # qiskit.providers.ibmq.random.CQCExtractorJob - + Representation of an asynchronous call to the CQC extractor. An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### extractor\_method - + Return the extractor method used. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### parameters - + Return the parameters passed to the extractor. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 24c303e0121..05823533946 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # qiskit.providers.ibmq.random.IBMQRandomService - + Random number services for an IBM Quantum Experience account provider. Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 05d473b67ab..feaf7b47f51 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # qiskit.providers.ibmq.runtime.IBMRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index ad43c3e6996..7e5ab6fc082 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # qiskit.providers.ibmq.runtime.ProgramBackend - + Base class for a program backend. This is a [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method. @@ -127,7 +127,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 8072ee197aa..7b533a26bc3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # qiskit.providers.ibmq.runtime.ResultDecoder - + Runtime job result decoder. You can subclass this class and overwrite the [`decode()`](#qiskit.providers.ibmq.runtime.ResultDecoder.decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") method to create a custom result decoder for the results of your runtime program. For example: @@ -39,7 +39,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index d43648bb174..dd1ba735cfd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # qiskit.providers.ibmq.runtime.RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`IBMRuntimeService.run`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") to execute a runtime program, or [`IBMRuntimeService.job`](qiskit.providers.ibmq.runtime.IBMRuntimeService#job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") to retrieve a previously executed job. @@ -125,7 +125,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### creation\_date - + Job creation date in local time. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### inputs - + Job input parameters. **Return type** @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### program\_id - + Program ID. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 9b93e45d061..115455457d7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # qiskit.providers.ibmq.runtime.RuntimeProgram - + Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### backend\_requirements - + Backend requirements. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### creation\_date - + Program creation date. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### description - + Program description. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### interim\_results - + Program interim result definitions. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### max\_execution\_time - + Maximum execution time in seconds. A program execution exceeding this time will be forcibly terminated. @@ -158,7 +158,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### name - + Program name. **Return type** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### parameters - + Program parameter definitions. **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### program\_id - + Program ID. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### return\_values - + Program return value definitions. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### version - + Program version. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 69cd7b328ec..5f1588ed725 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # qiskit.providers.ibmq.runtime.UserMessenger - + Base class for handling communication with program users. This class can be used when writing a new Qiskit Runtime program. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.mdx index 835c69bffe8..3966f38ccc8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # qiskit.providers.models.BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -171,7 +171,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.mdx index 19831bd1248..4ac5e58fa39 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # qiskit.providers.models.BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.mdx index 7ee84f27f2e..cfa0d4bcb58 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # qiskit.providers.models.BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.Command.mdx index f271532881b..09339522c2e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # qiskit.providers.models.Command - + Class representing a Command. ### name @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.mdx index 6328f6e2f8a..9cadfb03502 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # qiskit.providers.models.GateConfig - + Class representing a Gate Configuration ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.mdx index ff641da23ac..4eef33439cc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # qiskit.providers.models.JobStatus - + Model for JobStatus. ### job\_id @@ -57,7 +57,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.mdx index 464ead889fa..201d8389a00 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # qiskit.providers.models.PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -222,7 +222,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. @@ -302,7 +302,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### sample\_rate - + Sample rate of the signal channels in Hz (1/dt). **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.mdx index 3f73d57c7ff..1ce944c27fd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # qiskit.providers.models.PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_est: `List`\[`float`] :param qubit\_freq\_est: Estimated qubit frequencies in GHz. :type meas\_freq\_est: `List`\[`float`] :param meas\_freq\_est: Estimated measurement cavity frequencies in GHz. :type buffer: `int` :param buffer: Default buffer time (in units of dt) between pulses. :type pulse\_library: `List`\[`PulseLibraryItem`] :param pulse\_library: Pulse name and sample definitions. :type cmd\_def: `List`\[`Command`] :param cmd\_def: Operation name and definition in terms of Commands. :type meas\_kernel: `Optional`\[`MeasurementKernel`] :param meas\_kernel: The measurement kernels :type discriminator: `Optional`\[`Discriminator`] :param discriminator: The discriminators :param \*\*kwargs: Other attributes for the super class. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.mdx index 5eb5950711a..df737732e9e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # qiskit.providers.models.QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -237,7 +237,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.mdx index bd425b6f965..be49880ae93 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # qiskit.providers.models.UchannelLO - + Class representing a U Channel LO ### q @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.mdx index 04c467487a0..de9e397a36c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # qiskit.pulse.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.mdx index e8849c39357..c1ba243408b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # qiskit.pulse.AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Call.mdx index c301aa87d8a..a21446bd64c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # qiskit.pulse.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Constant.mdx index 98d9088c783..99040f927d4 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # qiskit.pulse.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.mdx index be438ad48cc..eb35cf8a9bd 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # qiskit.pulse.ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.ControlChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.ControlChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.ControlChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Delay.mdx index 4ba9ee473c3..aa4746f0f2f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # qiskit.pulse.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Drag.mdx index 174790576a5..a7c91e4f7c9 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # qiskit.pulse.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.mdx index c8966755f80..51d1d84cd36 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # qiskit.pulse.DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.DriveChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.DriveChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.DriveChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.mdx index 4961ba06abb..eff0e640dcd 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # qiskit.pulse.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.mdx index 6842ecdee91..bc3d3c43b1e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # qiskit.pulse.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.mdx index dbb0c789ab0..2b54880946e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # qiskit.pulse.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.mdx index d58be50ce63..9b96447fb6f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: 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: ```python @@ -155,7 +155,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap ### instructions - + Return all instructions which have definitions. By default, these are typically the basis gates along with other instructions such as measure and reset. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.mdx index d0845b04c06..697c9f789f3 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # qiskit.pulse.MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.mdx index 0d50a138f42..e113a86c2ad 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # qiskit.pulse.MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MemorySlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MemorySlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MemorySlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Play.mdx index 70aac063699..765ff73c74e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # qiskit.pulse.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.27/qiskit.pulse.PulseError.mdx index fb3138e4440..66e757720f6 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.mdx index f1f6b07fd9b..00735c5b621 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # qiskit.pulse.RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.mdx index 81b5b6f5204..2e66e3220b4 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # qiskit.pulse.Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Pulse program representation for the original Qiskit Pulse model \[1]. Instructions are not allowed to overlap in time on the same channel. This overlap constraint is immediately evaluated when a new instruction is added to the `Schedule` object. @@ -198,7 +198,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -280,7 +280,7 @@ $$ ### duration - + Duration of this schedule. **Return type** @@ -381,7 +381,7 @@ $$ ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -401,7 +401,7 @@ $$ ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -413,7 +413,7 @@ $$ ### name - + Name of this Schedule **Return type** @@ -423,7 +423,7 @@ $$ ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -508,7 +508,7 @@ $$ ### start\_time - + Starting time of this schedule. **Return type** @@ -518,7 +518,7 @@ $$ ### stop\_time - + Stopping time of this schedule. **Return type** @@ -528,7 +528,7 @@ $$ ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.mdx index 7f7e8d818fd..27de9bbd485 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # qiskit.pulse.ScheduleBlock - + A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. `ScheduleBlock` s should be initialized with one of the following alignment contexts: @@ -121,7 +121,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### alignment\_context - + Return alignment instance that allocates block component to generate schedule. @@ -212,7 +212,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### channels - + Returns channels that this schedule clock uses. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### duration - + Duration of this schedule block. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -435,7 +435,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -447,7 +447,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### name - + Name of this Schedule **Return type** @@ -457,7 +457,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -507,7 +507,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### start\_time - + Starting time of this schedule block. **Return type** @@ -517,7 +517,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### stop\_time - + Stopping time of this schedule block. **Return type** @@ -527,7 +527,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.mdx index 5eb564a59c4..500244af041 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # qiskit.pulse.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.mdx index c6f37e0bb03..0486fd77125 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # qiskit.pulse.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.mdx index bc377ab9bd0..6ff1db22a6e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # qiskit.pulse.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.mdx index ddae5dbc5de..9c40b64e207 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # qiskit.pulse.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.mdx index bd6ca6ac928..6a91d1d2082 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # qiskit.pulse.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.27/qiskit.pulse.Waveform.mdx index 770451a88cc..d6c14cb7d96 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # qiskit.pulse.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.27/qiskit.pulse.channels.mdx index e0b5f43be86..a87854aa1a6 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.channels.mdx @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -68,7 +68,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -88,7 +88,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -98,7 +98,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -109,7 +109,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -147,7 +147,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -167,7 +167,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -177,7 +177,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -194,7 +194,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -228,7 +228,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -248,7 +248,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -258,7 +258,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -269,7 +269,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -303,7 +303,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -323,7 +323,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -333,7 +333,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -344,7 +344,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -378,7 +378,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -398,7 +398,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -408,7 +408,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -419,7 +419,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -453,7 +453,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -473,7 +473,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -483,7 +483,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -494,7 +494,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -528,7 +528,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -548,7 +548,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -558,7 +558,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -569,7 +569,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -603,7 +603,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -623,7 +623,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -633,7 +633,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -644,7 +644,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify instructions for simulators. Create new snapshot channel. @@ -674,7 +674,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -694,7 +694,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -704,7 +704,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.mdx index af9f8dbb6a9..660d4e1ef23 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # qiskit.pulse.instructions.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.mdx index 6a3c37b217d..608894d76fe 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # qiskit.pulse.instructions.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.instructions.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.instructions.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.instructions.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.instructions.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.instructions.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.instructions.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.instructions.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.instructions.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.mdx index 8369b86de1d..56efceb15af 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # qiskit.pulse.instructions.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.mdx index 3f66630c539..89245bafc8e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # qiskit.pulse.instructions.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.mdx index 68536f999f7..c2dacd0a149 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # qiskit.pulse.instructions.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.mdx index 302bc37ba37..b084a04889d 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # qiskit.pulse.instructions.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.mdx index 93cf1ad2699..5cf2ae154e0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # qiskit.pulse.instructions.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.mdx index 5a8930f2920..1dabcd5fed6 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # qiskit.pulse.instructions.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.mdx index f0221bed8b8..1fa264f637f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # qiskit.pulse.instructions.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.mdx index dc7b7ff5b4e..352a9384892 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # qiskit.pulse.instructions.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.mdx index 7eb62e78e52..6233339c1e7 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # qiskit.pulse.library.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -58,7 +58,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -154,7 +154,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -174,7 +174,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.mdx index a51fe226b4f..46679e23f40 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # qiskit.pulse.library.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -76,7 +76,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -114,7 +114,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -182,7 +182,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -202,7 +202,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -212,7 +212,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.mdx index dda44ccfc77..3101aaa187a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # qiskit.pulse.library.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -60,7 +60,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -156,7 +156,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -176,7 +176,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -186,7 +186,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.mdx index d18de5bda5e..b4c75c6bfaf 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # qiskit.pulse.library.GaussianSquare - + A square pulse with a Gaussian shaped risefall on either side: $$ @@ -63,7 +63,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -159,7 +159,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -179,7 +179,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -189,7 +189,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -213,7 +213,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.mdx index 2d79eee73c6..539f80531ef 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # qiskit.pulse.library.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -116,7 +116,7 @@ python_api_name: qiskit.pulse.library.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.pulse.library.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.pulse.library.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.mdx index 608593533b7..ca41aa3b3a8 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # qiskit.qasm.OpenQASMLexer - + A pygments lexer for OpenQasm. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.27/qiskit.qasm.Qasm.mdx index 70d410e9d98..63643e69578 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.27/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # qiskit.qasm.Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.27/qiskit.qasm.QasmError.mdx index 14cd87fd355..6f66c674dd7 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.mdx index d237f6cc831..3bfc1bb74cd 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # qiskit.qasm.QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.mdx index 1a4ba1855b3..c934e1e9a97 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # qiskit.qasm.QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.mdx index 92e3b6ecd21..2080aa686db 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # qiskit.qobj.GateCalibration - + Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. Initialize a single gate calibration. Instructions may reference waveforms which should be made available in the pulse\_library. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.mdx index a16243a4252..00271820301 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # qiskit.qobj.PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.mdx index 64ff513dfab..7db8fd837ed 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # qiskit.qobj.PulseQobj - + A Pulse Qobj. Instantiate a new Pulse Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.mdx index e89d9636d04..046832aa29f 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # qiskit.qobj.PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.mdx index 74b0437befc..397d7c6b08f 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # qiskit.qobj.PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.mdx index f9f59971220..a322a985846 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # qiskit.qobj.PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.mdx index 033ce00ecff..e2a4d3161a6 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # qiskit.qobj.PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -69,7 +69,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.mdx index 9c1676d51e0..950978a2122 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # qiskit.qobj.QasmExperimentCalibrations - + A container for any calibrations data. The gates attribute contains a list of GateCalibrations. Initialize a container for calibrations. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.mdx index 7eda1eb6859..c9a1b870632 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # qiskit.qobj.QasmQobj - + A QASM Qobj. Instantiate a new QASM Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.mdx index 591875f1890..34ee1f024be 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # qiskit.qobj.QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.mdx index a5471ffae90..8fd80a224c6 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # qiskit.qobj.QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.mdx index f0fdc45a153..81c2439bc39 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # qiskit.qobj.QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.mdx index 1c7452d3042..c7263876019 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # qiskit.qobj.QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instantiate a new QasmQobjInstruction object. @@ -59,7 +59,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.27/qiskit.qobj.Qobj.mdx index 2168992b323..45efedcd247 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # qiskit.qobj.Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.mdx index a2f87d48f39..53b1a30cd5d 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # qiskit.qobj.QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.mdx index 1ca7a1fdafb..be9f79fb536 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # qiskit.qobj.QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.mdx index 1e53087d0c8..ed169601163 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # qiskit.qobj.QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.mdx index 32369bab1cc..964f8c55e08 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # qiskit.quantum\_info.CNOTDihedral - + An N-qubit operator from the CNOT-Dihedral group. > The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -216,7 +216,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### qargs - + Return the qargs for the operator. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.mdx index e5b0d1fe285..9199d2d2966 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # qiskit.quantum\_info.Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.mdx index 922747afa95..ac260b1ee2d 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # qiskit.quantum\_info.Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.mdx index a1b491e0259..a29ae1c1cff 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # qiskit.quantum\_info.Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -158,13 +158,13 @@ python_api_name: qiskit.quantum_info.Clifford ### destabilizer - + Return the destabilizer block of the StabilizerTable. ### dim - + Return tuple (input\_shape, output\_shape). @@ -209,7 +209,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -231,13 +231,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -297,7 +297,7 @@ python_api_name: qiskit.quantum_info.Clifford ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -331,7 +331,7 @@ python_api_name: qiskit.quantum_info.Clifford ### qargs - + Return the qargs for the operator. @@ -361,13 +361,13 @@ python_api_name: qiskit.quantum_info.Clifford ### stabilizer - + Return the stabilizer block of the StabilizerTable. ### table - + Return StabilizerTable diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.mdx index 6e5dd41cf01..e4ee2bb649a 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # qiskit.quantum\_info.DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### data - + Return data. ### dim - + Return total state dimension. @@ -227,7 +227,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -277,7 +277,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -336,7 +336,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -480,7 +480,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.mdx index 782285ef5f9..1b347a34c1d 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # qiskit.quantum\_info.Kraus - + Kraus representation of a quantum channel. For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -112,7 +112,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -164,13 +164,13 @@ $$ ### data - + Return list of Kraus matrices for channel. ### dim - + Return tuple (input\_shape, output\_shape). @@ -245,7 +245,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -283,7 +283,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -313,7 +313,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 67fe93c0e6c..8bf5627f545 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # qiskit.quantum\_info.OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ Euler parameters are used. @@ -106,7 +106,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer ### basis - + The decomposition basis. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.mdx index 8d9c60b9fe6..b8aacd8dad4 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # qiskit.quantum\_info.Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -102,7 +102,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -150,13 +150,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -221,7 +221,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -259,7 +259,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -293,7 +293,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -339,7 +339,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.mdx index dee7440785f..53925f8bb91 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # qiskit.quantum\_info.PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -116,7 +116,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -168,13 +168,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -249,7 +249,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -287,7 +287,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -317,7 +317,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.mdx index c89c32f8516..615234b1ef9 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # qiskit.quantum\_info.Pauli - + N-qubit Pauli operator. This class represents an operator $P$ from the full $n$-qubit *Pauli* group @@ -318,7 +318,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -407,7 +407,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -521,7 +521,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -533,7 +533,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -553,7 +553,7 @@ $$ ### phase - + Return the group phase exponent for the Pauli. @@ -581,13 +581,13 @@ $$ ### qargs - + Return the qargs for the operator. ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -632,7 +632,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -646,7 +646,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](#qiskit.quantum_info.Pauli.compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](#qiskit.quantum_info.Pauli.dot "qiskit.quantum_info.Pauli.dot"). @@ -807,13 +807,13 @@ $$ ### x - + The x vector for the Pauli. ### z - + The z vector for the Pauli. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.mdx index 1021681ac37..9c2626cf2e6 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # qiskit.quantum\_info.PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -142,13 +142,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). @@ -200,7 +200,7 @@ $$ ### array - + The underlying boolean array. @@ -327,7 +327,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -410,7 +410,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -501,7 +501,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -535,7 +535,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -565,13 +565,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.mdx index a5a97ea9722..599df402489 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # qiskit.quantum\_info.Quaternion - + A class representing a Quaternion. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.mdx index 44802a1fa84..1161803daac 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # qiskit.quantum\_info.ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -79,13 +79,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeff - + Return the coefficient @@ -133,7 +133,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,7 +190,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -220,7 +220,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### qargs - + Return the qargs for the operator. @@ -250,7 +250,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.mdx index e9bb387e501..43219c97c67 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # qiskit.quantum\_info.SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -91,13 +91,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeffs - + Return the Pauli coefficients. @@ -145,7 +145,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -190,13 +190,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -283,7 +283,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -317,7 +317,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### qargs - + Return the qargs for the operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### rtol - + Default relative tolerance parameter for float comparisons. @@ -372,13 +372,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### size - + The number of Pauli of Pauli terms in the operator. ### table - + Return the the PauliTable. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.mdx index 7053ba7d640..9445c9bbf7e 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # qiskit.quantum\_info.StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -156,13 +156,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). @@ -216,7 +216,7 @@ $$ ### array - + The underlying boolean array. @@ -354,7 +354,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -446,7 +446,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -549,7 +549,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -561,13 +561,13 @@ $$ ### pauli - + Return PauliTable ### phase - + Return phase vector @@ -595,7 +595,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -625,13 +625,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.mdx index 07210dd6300..5d29189579b 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # qiskit.quantum\_info.Statevector - + Statevector class Initialize a statevector object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.Statevector ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.Statevector ### data - + Return data. ### dim - + Return total state dimension. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -275,7 +275,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -360,7 +360,7 @@ python_api_name: qiskit.quantum_info.Statevector ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -504,7 +504,7 @@ python_api_name: qiskit.quantum_info.Statevector ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.mdx index 10c726b40f5..725541e1e14 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # qiskit.quantum\_info.Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -114,7 +114,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -166,13 +166,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -247,7 +247,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -285,7 +285,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -315,7 +315,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.mdx index 04338e9cf8e..91a65b95a30 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # qiskit.quantum\_info.SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -108,7 +108,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -160,13 +160,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -241,7 +241,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -279,7 +279,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -309,7 +309,7 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 585d2b7b061..df78f8c51e5 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # qiskit.quantum\_info.TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.27/qiskit.result.Counts.mdx b/docs/api/qiskit/0.27/qiskit.result.Counts.mdx index 5831bf958c9..dfc594b5039 100644 --- a/docs/api/qiskit/0.27/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.27/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # qiskit.result.Counts - + A class to store a counts result from a circuit execution. Build a counts object diff --git a/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.mdx index 9087f8a6e0e..aa271844d8b 100644 --- a/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # qiskit.result.ProbDistribution - + A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.mdx index 89c87e3e078..84a406f4ceb 100644 --- a/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # qiskit.result.QuasiDistribution - + A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.27/qiskit.result.Result.mdx b/docs/api/qiskit/0.27/qiskit.result.Result.mdx index d44379b7084..e6d211777b0 100644 --- a/docs/api/qiskit/0.27/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.27/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # qiskit.result.Result - + Model for Results. ### backend\_name @@ -124,7 +124,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.27/qiskit.result.ResultError.mdx index e250fb23a88..0fd70dbb09b 100644 --- a/docs/api/qiskit/0.27/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.27/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.mdx index ab85076a420..4128437aeeb 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # qiskit.scheduler.ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.mdx index 27d9febaa5d..81451cc6f50 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # qiskit.transpiler.AnalysisPass - + An analysis pass: change property set, not DAG. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.mdx index f3513b34883..1f57c22118a 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # qiskit.transpiler.CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### distance\_matrix - + Return the distance matrix for the coupling map. @@ -133,25 +133,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### is\_symmetric - + Test if the graph is symmetric. Return True if symmetric, False otherwise @@ -207,7 +207,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### physical\_qubits - + Returns a sorted list of physical\_qubits diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.mdx index 246e3c2b753..143c7f14c71 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # qiskit.transpiler.FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.mdx index 5402b16609b..192aa4b068e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # qiskit.transpiler.FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.mdx index 54a1f8f3805..26dcb48f808 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # qiskit.transpiler.FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.mdx index 4a2329edcfb..8c31bda65f1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # qiskit.transpiler.InstructionDurations - + Helper class to provide durations of instructions for scheduling. It stores durations (gate lengths) and dt to be used at the scheduling stage of transpiling. It can be constructed from `backend` or `instruction_durations`, which is an argument of `transpile()`. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.Layout.mdx index d3a9aa839fa..021d615fdc6 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # qiskit.transpiler.Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -135,7 +135,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.mdx index d4d660772d1..c0d1088947b 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # qiskit.transpiler.PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.mdx index 230818965be..c6bd129c327 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # qiskit.transpiler.PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.mdx index a3115e25f10..61334a1ff05 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # qiskit.transpiler.PropertySet - + A default dictionary-like object ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.mdx index ac664e71627..2b453ee2c63 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # qiskit.transpiler.TransformationPass - + A transformation pass: change DAG, not property set. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.mdx index 2ec9052b1b9..ea4d333a912 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.mdx index a97f0a76b52..78f17c62b2e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.mdx index dad51e462f2..56892c05a47 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # qiskit.transpiler.passes.ALAPSchedule - + ALAP Scheduling. ALAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.mdx index e99b9ec0bbf..1a08de4dec9 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # qiskit.transpiler.passes.ASAPSchedule - + ASAP Scheduling. ASAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.mdx index b620fafa85d..9c9acce6352 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # qiskit.transpiler.passes.ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 15919b00dfc..bf49e66d4b1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # qiskit.transpiler.passes.BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.mdx index f38dc741ff3..02dd5d86ccc 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # qiskit.transpiler.passes.BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.mdx index 2b63c4cf378..3d642698549 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # qiskit.transpiler.passes.BasisTranslator - + Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. This pass operates in several steps: @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.mdx index 7503e8a4690..b9e24361d31 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # qiskit.transpiler.passes.CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.mdx index 9fd094457b2..f0b70609883 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # qiskit.transpiler.passes.CXCancellation - + Cancel back-to-back cx gates in dag. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.mdx index 34c871833d3..2d271a2bff4 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # qiskit.transpiler.passes.CXDirection - + Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. GateDirection pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.mdx index e667de9216d..a9b9918cb9b 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # qiskit.transpiler.passes.CheckCXDirection - + Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.mdx index f6510901f47..1ccb478b0f8 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # qiskit.transpiler.passes.CheckGateDirection - + Check if the two-qubit gates follow the right direction with respect to the coupling map. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.mdx index d6377cd2b8d..4bf3ed3ade9 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # qiskit.transpiler.passes.CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.mdx index 38255168c0e..5d39dd2bf04 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # qiskit.transpiler.passes.Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to property\_set as a dictionary of the form: @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.mdx index 9ef9b0d91df..244d8076fc5 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # qiskit.transpiler.passes.CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.mdx index fe5e7136155..75a0384281c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # qiskit.transpiler.passes.CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 43236b08928..3d3d468d1a4 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # qiskit.transpiler.passes.ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.mdx index 9408bb28f04..6bf971c0bae 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # qiskit.transpiler.passes.CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.mdx index acde255c6dd..41e9e46899f 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # qiskit.transpiler.passes.CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index e81aa1e1f2e..b6e2e15a0ac 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # qiskit.transpiler.passes.CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. @@ -216,7 +216,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -230,7 +230,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.mdx index d7439329702..80690c14816 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # qiskit.transpiler.passes.DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.mdx index 243679d198b..08f525f0379 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # qiskit.transpiler.passes.DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.mdx index cb71701d9b4..985084c6131 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # qiskit.transpiler.passes.Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.mdx index 3b877f5d3cf..00644d786ac 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # qiskit.transpiler.passes.DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.mdx index 1407152212d..a8ed13af4eb 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # qiskit.transpiler.passes.Depth - + Calculate the depth of a DAG circuit. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e32e846b624..9a5cdfa7d81 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # qiskit.transpiler.passes.EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.mdx index 9d83ac7e79b..fdba1fade22 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # qiskit.transpiler.passes.FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 035d7b87fb8..8b34c584905 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # qiskit.transpiler.passes.FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.mdx index 1de86ce793b..36648a24aef 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # qiskit.transpiler.passes.GateDirection - + Modify asymmetric gates to match the hardware coupling direction. This pass makes use of the following identities: @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.mdx index b453a21a63d..755fd759005 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # qiskit.transpiler.passes.Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.mdx index dd4c07bfe2c..c28e00b7e0d 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # qiskit.transpiler.passes.LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 1efdb3e8659..527fe9f42e2 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # qiskit.transpiler.passes.MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 0fe1486f40a..e8f2223c7b0 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # qiskit.transpiler.passes.NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.mdx index d1b67c0a487..2c1222ddf99 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # qiskit.transpiler.passes.NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.mdx index 9b24675e825..767990f30bd 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # qiskit.transpiler.passes.Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index ae009c4f21e..4856eab18db 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # qiskit.transpiler.passes.Optimize1qGatesDecomposition - + Optimize chains of single-qubit gates by combining them into a single gate. Optimize1qGatesDecomposition initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index f1c75bd3033..01322294748 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # qiskit.transpiler.passes.RZXCalibrationBuilder - + Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). Initializes a RZXGate calibration builder. @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -84,7 +84,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 05ecc6af7c5..b709e0df4cc 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 8675f915984..544b2c169a9 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # qiskit.transpiler.passes.RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 1d330a94c68..30e2e8cb627 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # qiskit.transpiler.passes.RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.mdx index 96b47bc92b3..482686be9a1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # qiskit.transpiler.passes.SabreLayout - + Choose a Layout via iterative bidirectional routing of the input circuit. Starting with a random initial Layout, the algorithm does a full routing of the circuit (via the routing\_pass method) to end up with a final\_layout. This final\_layout is then used as the initial\_layout for routing the reverse circuit. The algorithm iterates a number of times until it finds an initial\_layout that reduces full routing cost. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.mdx index 2c4048bb9e5..2e1ea7666fd 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # qiskit.transpiler.passes.SabreSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of the SWAP-based heuristic search from the SABRE qubit mapping paper \[1] (Algorithm 1). The heuristic aims to minimize the number of lossy SWAPs inserted and the depth of the circuit. @@ -124,7 +124,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -132,7 +132,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.mdx index 4f07c35e469..c129fa18359 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # qiskit.transpiler.passes.SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.mdx index 1cc78e62958..9724f37f99e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # qiskit.transpiler.passes.Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.mdx index fa0c8d61405..60dbbf22504 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # qiskit.transpiler.passes.StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.mdx index ee9a49ac213..4ac6d9921c4 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # qiskit.transpiler.passes.TemplateOptimization - + Class for the template optimization pass. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.mdx index 446a5bdd47a..7d7b18a389c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # qiskit.transpiler.passes.TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.mdx index 9f9436bd943..300a570ad78 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # qiskit.transpiler.passes.UnitarySynthesis - + Synthesize gates according to their basis gates. Synthesize unitaries over some basis gates. @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f3ef3c0cc34..8f3901e44a2 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # qiskit.transpiler.passes.Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 4db4a49e651..e48b1b53bc6 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # qiskit.transpiler.passes.UnrollCustomDefinitions - + Unrolls instructions with custom definitions. Unrolls instructions with custom definitions. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.mdx index 8080d5ce674..76547951fcb 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # qiskit.transpiler.passes.Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.mdx index 7b5f85bb346..81f5ce6b7cb 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # qiskit.transpiler.passes.Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.mdx index dbb7bf7d1c5..2133ce1dd4f 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # qiskit.utils.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.utils.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.utils.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.utils.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.utils.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.utils.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.utils.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.mdx index ecb289e5ad6..daa77f3d557 100644 --- a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.mdx index 335265d4046..34e2e716b0d 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 054aacd5461..19e5fff1228 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # qiskit.visualization.pulse\_v2.IQXDebugging - + Pulse stylesheet for pulse programmers. Show details of instructions. \# TODO: add more generators diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.mdx index a04d7e247b5..efea44d0361 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # qiskit.visualization.pulse\_v2.IQXSimple - + Simple pulse stylesheet without channel notation. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.mdx index 9255beb4f13..6601a544500 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # qiskit.visualization.pulse\_v2.IQXStandard - + Standard pulse stylesheet. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.mdx index bb00e78d3b3..43aeb361123 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # qiskit.visualization.qcstyle.DefaultStyle - + Creates a Default Style dictionary **Style Dict Details** diff --git a/docs/api/qiskit/0.28/logging.mdx b/docs/api/qiskit/0.28/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.28/logging.mdx +++ b/docs/api/qiskit/0.28/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.mdx index 2cb62347d48..2277cf5ed60 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.mdx index 6f153fccd51..3312c75b0fb 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # qiskit.algorithms.AmplificationProblem - + The amplification problem is the input to amplitude amplification algorithms, like Grover. This class contains all problem-specific information required to run an amplitude amplification algorithm. It minimally contains the Grover operator. It can further hold some post processing on the optimal bitstring. @@ -62,7 +62,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### is\_good\_state - + Check whether a provided bitstring is a good state or not. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### objective\_qubits - + The indices of the objective qubits. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### oracle - + Return the oracle. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem ### state\_preparation - + Get the state preparation operator $\mathcal{A}$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.mdx index cdfa42839f9..fcba47deb99 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # qiskit.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -76,7 +76,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -101,7 +101,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** @@ -184,7 +184,7 @@ $$ ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.mdx index 04902b4a7ff..9857af4bb3d 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # qiskit.algorithms.AmplitudeEstimationResult - + The `AmplitudeEstimation` result object. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### measurements - + Return the measurements as integers with their measurement probability. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle - + Return the MLE for the amplitude, in $\[0, 1]\$. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### mle\_processed - + Return the post-processed MLE for the amplitude. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_evaluation\_qubits - + Returns the number of evaluation qubits. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples - + Return the measurement samples with their measurement probability. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### samples\_processed - + Return the post-processed measurement samples with their measurement probability. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.mdx index a9b8feee081..1c38aa6d444 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # qiskit.algorithms.AmplitudeEstimator - + The Amplitude Estimation interface. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 9fae92af095..908aa7a7433 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # qiskit.algorithms.AmplitudeEstimatorResult - + The results object for amplitude estimation algorithms. ### \_\_init\_\_ @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.mdx index 0a750174cff..cff3ebb26ad 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # qiskit.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.mdx index 594d75b8a18..9a121455cce 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # qiskit.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.mdx index e7924b4ad37..f1693b94c69 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # qiskit.algorithms.EstimationProblem - + The estimation problem is the input to amplitude estimation algorithm. This class contains all problem-specific information required to run an amplitude estimation algorithm. That means, it minimally contains the state preparation and the specification of the good state. It can further hold some post processing on the estimation of the amplitude or a custom Grover operator. @@ -52,7 +52,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### is\_good\_state - + Checks whether a bitstring represents a good state. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### post\_processing - + Apply post processing to the input value. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.EstimationProblem ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 31a8356da9f..4864512bddf 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # qiskit.algorithms.FasterAmplitudeEstimation - + The Faster Amplitude Estimation algorithm. The Faster Amplitude Estimation (FAE) \[1] algorithm is a variant of Quantum Amplitude Estimation (QAE), where the Quantum Phase Estimation (QPE) by an iterative Grover search, similar to \[2]. @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index d8e559e8a27..6c3d9b691dd 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # qiskit.algorithms.FasterAmplitudeEstimationResult - + The result object for the Faster Amplitude Estimation algorithm. ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_first\_state\_steps - + Return the number of steps taken in the first step of algorithm. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### num\_steps - + Return the total number of steps taken in the algorithm. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### success\_probability - + Return the success probability of the algorithm. **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.Grover.mdx index 78ec73fa736..e2a024e7ed8 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # qiskit.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -159,7 +159,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -178,7 +178,7 @@ $$ ### quantum\_instance - + Get the quantum instance. :rtype: `Optional`\[`QuantumInstance`] :returns: The quantum instance used to run this algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.mdx index fdd249dcdf6..765ae8dfa55 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # qiskit.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.GroverResult ### assignment - + The post-processed value of the most likely bitstring. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.GroverResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.GroverResult ### iterations - + All the powers of the Grover operator that have been tried. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.GroverResult ### max\_probability - + Return the maximum sampling probability. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.GroverResult ### oracle\_evaluation - + Whether the classical oracle evaluation of the top measurement was True or False. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.GroverResult ### top\_measurement - + The most frequently measured output as bitstring. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.HHL.mdx index 4db51e4ba16..0bcd9ca4459 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # qiskit.algorithms.HHL - + 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. A system of linear equations is called $s$-sparse if $A$ has at most $s$ non-zero entries per row or column. Solving an $s$-sparse system of size $N$ with a classical computer requires $\mathcal{ O }(Ns\kappa\log(1/\epsilon))$ running time using the conjugate gradient method. Here $\kappa$ denotes the condition number of the system and $\epsilon$ the accuracy of the approximation. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.HHL ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.HHL ### quantum\_instance - + Get the quantum instance. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.HHL ### scaling - + The scaling of the solution vector. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 81d0336818d..40f438de8bb 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # qiskit.algorithms.HamiltonianPhaseEstimation - + Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 66b91e645ae..05184e44521 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # qiskit.algorithms.HamiltonianPhaseEstimationResult - + Store and manipulate results from running HamiltonianPhaseEstimation. This API of this class is nearly the same as PhaseEstimatorResult, differing only in the presence of an additional keyword argument in the methods. If scaled is False, then the phases are not translated and scaled to recover the eigenvalues of the Hamiltonian. Instead phi in $[0, 1)$ is returned, as is the case when then unitary is not derived from a Hamiltonian. @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_eigenvalue - + The most likely eigenvalue of the Hamiltonian. This method calls most\_likely\_phase and scales the result to obtain an eigenvalue. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### most\_likely\_phase - + DEPRECATED - The most likely phase of the unitary corresponding to the Hamiltonian. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult ### phase - + The most likely phase of the unitary corresponding to the Hamiltonian. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 8d56d2c0f02..83aefbf228b 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # qiskit.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### epsilon\_target - + Returns the target precision `epsilon_target` of the algorithm. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index d72426307b2..7dc67af47b1 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # qiskit.algorithms.IterativeAmplitudeEstimationResult - + The `IterativeAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### alpha - + Return the confidence level $\alpha$. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated - + Return the estimated half-width of the confidence interval. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_estimated\_processed - + Return the post-processed estimated half-width of the confidence interval. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### epsilon\_target - + Return the target half-width of the confidence interval. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimate\_intervals - + Return the confidence intervals for the estimate in each iteration. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### powers - + Return the powers of the Grover operator in each iteration. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### ratios - + Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + Return the confidence intervals for the angles in each iteration. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.mdx index 0992ab72830..4a2b2f8fc41 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # qiskit.algorithms.IterativePhaseEstimation - + Run the Iterative quantum phase estimation (QPE) algorithm. Given a unitary circuit and a circuit preparing an eigenstate, return the phase of the eigenvalue as a number in $[0,1)$ using the iterative phase estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.mdx index 2930e5128ac..164ae55af2d 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # qiskit.algorithms.LinearSolver - + An abstract class for linear system solvers in Qiskit. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.mdx index 85668e28596..970fc545da1 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # qiskit.algorithms.LinearSolverResult - + A base class for linear systems results. The linear systems algorithms return an object of the type `LinearSystemsResult` with the information about the solution obtained. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### circuit\_results - + return the results from the circuits **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### euclidean\_norm - + return the euclidean norm if the algorithm knows how to calculate it **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### observable - + return the (list of) calculated observable(s) **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult ### state - + return either the circuit that prepares the solution or the solution as a vector **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 3e2c22658de..fbf3aca0fdc 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -65,7 +65,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### quantum\_instance - + Get the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 28d9c68d05a..c2b65de9e78 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + The `MaximumLikelihoodAmplitudeEstimation` result object. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### circuit\_results - + Return the circuit results. Can be a statevector or counts dictionary. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval - + Return the confidence interval for the amplitude (95% interval by default). **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### confidence\_interval\_processed - + Return the post-processed confidence interval (95% interval by default). **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation - + Return the estimation for the amplitude in $[0, 1]$. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### estimation\_processed - + Return the estimation for the amplitude after the post-processing has been applied. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### evaluation\_schedule - + Return the evaluation schedule for the powers of the Grover operator. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### fisher\_information - + Return the Fisher information for the estimated amplitude. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### good\_counts - + Return the percentage of good counts per circuit power. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### minimizer - + Return the minimizer used for the search of the likelihood function. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### num\_oracle\_queries - + Return the number of Grover oracle queries. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### post\_processing - + Return a handle to the post processing function. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### shots - + Return the number of shots used. Is 1 for statevector-based simulations. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult ### theta - + Return the estimate for the angle $\theta$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.mdx index 1503b3ea5f3..369b6e9dbcc 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # qiskit.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.mdx index 13805d82744..b29d30b5724 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # qiskit.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.mdx index 0fa936132a6..7d9bd13f3d6 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # qiskit.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.mdx index ae856507298..a402e90aea8 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # qiskit.algorithms.NumPyLinearSolver - + The Numpy Linear Solver algorithm (classical). This linear system solver computes the exact value of the given observable(s) or the full solution vector if no observable is specified. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.mdx index adbba946357..e18035f9f7e 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # qiskit.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.mdx index 2392f3e161d..fb16d8e3117 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # qiskit.algorithms.PhaseEstimation - + Run the Quantum Phase Estimation (QPE) algorithm. This runs QPE with a multi-qubit register for reading the phases \[1] of input states. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.mdx index cb214835383..b4fd79e07c0 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # qiskit.algorithms.PhaseEstimationResult - + Store and manipulate results from running PhaseEstimation. This class is instantiated by the `PhaseEstimation` class, not via user code. The `PhaseEstimation` class generates a list of phases and corresponding weights. Upon completion it returns the results as an instance of this class. The main method for accessing the results is filter\_phases. @@ -50,7 +50,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### circuit\_result - + Return the result object returned by running the QPE circuit (on hardware or simulator). This is useful for inspecting and troubleshooting the QPE algorithm. @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### most\_likely\_phase - + DEPRECATED - Return the most likely phase as a number in $[0.0, 1.0)$. 1.0 corresponds to a phase of $2\pi$. This selects the phase corresponding to the bit string with the highesest probability. This is the most likely phase. @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### phase - + Return the most likely phase as a number in $[0.0, 1.0)$. 1.0 corresponds to a phase of $2\pi$. This selects the phase corresponding to the bit string with the highesest probability. This is the most likely phase. @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult ### phases - + Return all phases and their frequencies computed by QPE. This is an array or dict whose values correspond to weights on bit strings. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.mdx index 5b0a440509a..66007bf3f3c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # qiskit.algorithms.PhaseEstimationScale - + Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. The `bound` is set when constructing this class. Then the method `scale` is used to find the factor by which to scale the operator. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### scale - + Return the Hamiltonian scaling factor. Return the scale factor by which a Hermitian operator must be multiplied so that the phase of the corresponding unitary is restricted to $[-\pi, \pi]$. This factor is computed from the bound on the absolute values of the eigenvalues of the operator. The methods `scale_phase` and `scale_phases` are used recover the eigenvalues corresponding the original (unscaled) Hermitian operator. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.mdx index ce537a20783..26659e42080 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # qiskit.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.QAOA ### ansatz - + Returns the ansatz. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.algorithms.QAOA ### gradient - + Returns the gradient. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -299,7 +299,7 @@ python_api_name: qiskit.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -353,13 +353,13 @@ python_api_name: qiskit.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.Shor.mdx index f7df34c2317..2721aff615b 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # qiskit.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.mdx index 95eeec55ba2..da3aa7227f3 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # qiskit.algorithms.ShorResult - + Shor Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.ShorResult ### factors - + returns factors **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.ShorResult ### successful\_counts - + returns successful counts **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.algorithms.ShorResult ### total\_counts - + returns total counts **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.VQE.mdx index e818fe12073..06389a9c738 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # qiskit.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a quantum algorithm that uses a variational technique to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.VQE ### ansatz - + Returns the ansatz. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.algorithms.VQE ### gradient - + Returns the gradient. **Return type** @@ -275,7 +275,7 @@ python_api_name: qiskit.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -285,7 +285,7 @@ python_api_name: qiskit.algorithms.VQE ### optimal\_params - + The optimal parameters for the ansatz. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -329,13 +329,13 @@ python_api_name: qiskit.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.mdx index 3302931150c..f4d32c28084 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # qiskit.algorithms.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,67 +127,67 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -297,13 +297,13 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -321,7 +321,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.mdx index 6edd8345d09..798fef25431 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # qiskit.algorithms.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,67 +129,67 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -247,13 +247,13 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -271,7 +271,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.mdx index cd867152fdd..1b6fbd453a2 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # qiskit.algorithms.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,67 +102,67 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -198,13 +198,13 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -222,7 +222,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.mdx index 8799dde87e7..bcd754cf0b0 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # qiskit.algorithms.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,67 +108,67 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -222,13 +222,13 @@ python_api_name: qiskit.algorithms.optimizers.CG ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -246,7 +246,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.mdx index 964e9cb04fb..dea632351ce 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # qiskit.algorithms.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,67 +104,67 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -218,13 +218,13 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.mdx index 5ae346b868b..afe425b5655 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # qiskit.algorithms.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,67 +113,67 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -227,13 +227,13 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -247,7 +247,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.mdx index 7f9116e9594..0646811c657 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # qiskit.algorithms.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,67 +113,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -227,13 +227,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -247,7 +247,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 3cd767aefb1..9297837ebb6 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # qiskit.algorithms.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,67 +113,67 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -227,13 +227,13 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -247,7 +247,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.mdx index 3ee3956c88e..81261914349 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # qiskit.algorithms.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,67 +115,67 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -229,13 +229,13 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -249,7 +249,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.mdx index 056c094cf35..19fcba83cfc 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # qiskit.algorithms.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -151,67 +151,67 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -343,13 +343,13 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -367,7 +367,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.mdx index 8ec497558d9..1f0219f321c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # qiskit.algorithms.optimizers.GradientDescent - + The gradient descent minimization routine. For a function $f$ and an initial point $\vec\theta_0$, the standard (or “vanilla”) gradient descent method is an iterative scheme to find the minimum $\vec\theta^*$ of $f$ by updating the parameters in the direction of the negative gradient of $f$ @@ -81,7 +81,7 @@ $$ ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ $$ ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -252,7 +252,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.mdx index 49ba7e612d4..62bca5adbf9 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # qiskit.algorithms.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,67 +102,67 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -198,13 +198,13 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -222,7 +222,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.mdx index a8ebc4cb077..2dd6e038425 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # qiskit.algorithms.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -92,7 +92,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,67 +113,67 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -227,13 +227,13 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -247,7 +247,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 45a6e0c4735..280375528e0 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # qiskit.algorithms.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -95,7 +95,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,67 +116,67 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -230,13 +230,13 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -254,7 +254,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index f354ae7a34b..102cd66ca6e 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # qiskit.algorithms.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,67 +110,67 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -224,13 +224,13 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -248,7 +248,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.mdx index 5d74a90cb60..533c0f04241 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # qiskit.algorithms.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -126,67 +126,67 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -240,13 +240,13 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -264,7 +264,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.mdx index b28a2110000..9396796c477 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # qiskit.algorithms.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -53,19 +53,19 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,73 +86,73 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -200,13 +200,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -224,7 +224,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 90f0460c0f2..5dac15e3341 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # qiskit.algorithms.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.mdx index e3fc8c6bf72..60d31d98a7f 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # qiskit.algorithms.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -85,7 +85,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,67 +106,67 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -220,13 +220,13 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -244,7 +244,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.mdx index 78271a7290e..e3a0f94979c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # qiskit.algorithms.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,67 +108,67 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -222,13 +222,13 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -246,7 +246,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.mdx index a2c86587b03..3d60056144a 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # qiskit.algorithms.optimizers.QNSPSA - + The Quantum Natural SPSA (QN-SPSA) optimizer. The QN-SPSA optimizer \[1] is a stochastic optimizer that belongs to the family of gradient descent methods. This optimizer is based on SPSA but attempts to improve the convergence by sampling the **natural gradient** instead of the vanilla, first-order gradient. It achieves this by approximating Hessian of the `fidelity` of the ansatz circuit. @@ -119,13 +119,13 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### bounds\_support\_level - + Returns bounds support level ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -158,7 +158,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -168,7 +168,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -202,7 +202,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -223,67 +223,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -337,13 +337,13 @@ $$ ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. @@ -357,7 +357,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.mdx index 545854a26c8..0b1ce95f9de 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # qiskit.algorithms.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,67 +110,67 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -224,13 +224,13 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -248,7 +248,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.mdx index 1335ef1d7cb..9d3c1eb34ae 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # qiskit.algorithms.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -87,7 +87,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,67 +108,67 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -204,13 +204,13 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -228,7 +228,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.mdx index 489827581e6..8d69f2d09d8 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # qiskit.algorithms.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA \[1] is an gradient descent method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -152,13 +152,13 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -191,7 +191,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -207,7 +207,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -228,67 +228,67 @@ $$ ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -342,13 +342,13 @@ $$ ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -362,7 +362,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index f5c5994050c..67e0c1d6c31 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # qiskit.algorithms.optimizers.SciPyOptimizer - + A general Qiskit Optimizer wrapping scipy.optimize.minimize. For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html) @@ -65,7 +65,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### bounds\_support\_level - + Returns bounds support level @@ -77,7 +77,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,67 +98,67 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -212,13 +212,13 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -236,7 +236,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.mdx index 777fcb56b47..6f27f7c6bf2 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # qiskit.algorithms.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### setting - + Return setting ### settings - + The optimizer settings in a dictionary format. The settings can for instance be used for JSON-serialization (if all settings are serializable, which e.g. doesn’t hold per default for callables), such that the optimizer object can be reconstructed as @@ -252,7 +252,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.28/qiskit.aqua.AquaError.mdx index cfb60f8d6da..b014309ee47 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.mdx index 537435976d9..ed6e75058c4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.mdx index 2915686d9f2..ba2584ac7ca 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # qiskit.aqua.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -164,19 +164,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -205,19 +205,19 @@ python_api_name: qiskit.aqua.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -241,25 +241,25 @@ python_api_name: qiskit.aqua.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -275,7 +275,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### run\_config - + Getter of run\_config. @@ -287,13 +287,13 @@ python_api_name: qiskit.aqua.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index fd56a255ecf..6a35fae521a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # qiskit.aqua.algorithms.AmplitudeEstimation - + The Quantum Phase Estimation-based Amplitude Estimation algorithm. This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid @@ -91,7 +91,7 @@ $$ ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -109,7 +109,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -161,7 +161,7 @@ $$ ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -177,7 +177,7 @@ $$ ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -219,7 +219,7 @@ $$ ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -251,7 +251,7 @@ $$ ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -273,7 +273,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -283,7 +283,7 @@ $$ ### random - + Return a numpy random. @@ -322,7 +322,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 5b9f724ff8a..873ab10b775 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult - + AmplitudeEstimationAlgorithm Result. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### a\_estimation - + return a\_estimation **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### estimation - + return estimation **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index de7e30b69ad..43e1456342e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # qiskit.aqua.algorithms.AmplitudeEstimationResult - + AmplitudeEstimation Result. ### \_\_init\_\_ @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### a\_samples - + return a\_samples **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### circuit\_result - + return circuit result **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_a\_samples - + return mapped\_a\_samples **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mapped\_values - + return mapped\_values **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### max\_probability - + return max\_probability **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### ml\_value - + returns ml\_value **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### mle - + return mle **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### probabilities - + return probabilities **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### shots - + return shots **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### y\_measurements - + return y\_measurements **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.mdx index ae4911c2635..44903b2aaf5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # qiskit.aqua.algorithms.BernsteinVazirani - + The Bernstein-Vazirani algorithm. The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jozsa algorithm. The goal of the algorithm is to determine a secret string $s \in \{0,1\}^n$, given a black box oracle function, that maps $f:\{0,1\}^n \rightarrow \{0,1\}$ such that $f(x)=s \cdot x (\bmod 2)$. @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index ba3f4257eed..80bf2b8b21c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # qiskit.aqua.algorithms.ClassicalAlgorithm - + Base class for Classical Algorithms. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index b99c7789762..fab4625a50d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # qiskit.aqua.algorithms.ClassicalCPLEX - + The Classical CPLEX algorithm (classical). This algorithm uses the IBM ILOG CPLEX Optimization Studio along with its separately installed Python API to solve optimization problems modeled as an Ising Hamiltonian. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### random - + Return a numpy random. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX ### solution - + return solution diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.mdx index 61f63f2b650..01f87c17ba6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # qiskit.aqua.algorithms.DeutschJozsa - + The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.mdx index 0f903e2a1ae..045557279ff 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # qiskit.aqua.algorithms.EOH - + The Quantum EOH (Evolution of Hamiltonian) algorithm. EOH provides the lower-level building blocks for simulating universal quantum systems. For any given quantum system that can be decomposed into local interactions (for example, a global hamiltonian as the weighted sum of several Pauli spin operators), the local interactions can then be used to approximate the global quantum system via, for example, Lloyd’s method or Trotter-Suzuki decomposition. @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.mdx index fb7faece3bf..547838264e3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # qiskit.aqua.algorithms.Eigensolver - + The Eigensolver Interface. Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.mdx index 33c8bb26b35..9dfaf18e713 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # qiskit.aqua.algorithms.EigensolverResult - + Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenstates - + return eigen states **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### eigenvalues - + returns eigen values **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.mdx index 7fd6fed3ae5..0a1d1a603a4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # qiskit.aqua.algorithms.Grover - + Grover’s Search algorithm. Grover’s Search \[1, 2] is a well known quantum algorithm for that can be used for searching through unstructured collections of records for particular targets with quadratic speedup compared to classical algorithms. @@ -145,7 +145,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -174,7 +174,7 @@ $$ ### grover\_operator - + Returns grover\_operator. **Return type** @@ -202,7 +202,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** @@ -239,7 +239,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -249,7 +249,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.mdx index eff6a058332..9dcb420e0d8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # qiskit.aqua.algorithms.GroverResult - + Grover Result. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### assignment - + return assignment **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### circuit - + return circuit **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### measurement - + returns measurement **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### oracle\_evaluation - + return oracle evaluation **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### top\_measurement - + return top measurement **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.mdx index f7b3190b727..b4aaeccb6fe 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # qiskit.aqua.algorithms.HHL - + The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. @@ -94,7 +94,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -122,7 +122,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -141,7 +141,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -160,7 +160,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** @@ -183,7 +183,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -193,7 +193,7 @@ $$ ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.mdx index 3efe7dde0ae..e7382b96c50 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # qiskit.aqua.algorithms.HHLResult - + HHL Result. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### circuit\_info - + return circuit info **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### matrix - + return matrix **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### output - + return output **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### probability\_result - + return probability result **Return type** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### solution - + return solution **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### vector - + return vector **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.mdx index 959b84047b5..3dd5a16d8d2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # qiskit.aqua.algorithms.IQPE - + The Iterative Quantum Phase Estimation algorithm. IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### random - + Return a numpy random. @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index d441266b937..85fba18f286 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # qiskit.aqua.algorithms.IterativeAmplitudeEstimation - + The Iterative Amplitude Estimation algorithm. This class implements the Iterative Quantum Amplitude Estimation (IQAE) algorithm, proposed in \[1]. The output of the algorithm is an estimate that, with at least probability $1 - \alpha$, differs by epsilon to the target value, where both alpha and epsilon can be specified. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -166,7 +166,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -254,7 +254,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -276,7 +276,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -286,7 +286,7 @@ $$ ### random - + Return a numpy random. @@ -325,7 +325,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index 5aa96c6cb2a..748d7af8f53 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult - + IterativeAmplitudeEstimation Result. ### \_\_init\_\_ @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_estimation - + return a\_estimation **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### a\_intervals - + return a\_intervals **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### actual\_epsilon - + return mle **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### alpha - + return alpha **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### confidence\_interval - + return confidence\_interval **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### estimation - + return estimation **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### powers - + return powers **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### ratios - + return ratios **Return type** @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### theta\_intervals - + return theta\_intervals **Return type** @@ -232,7 +232,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### value\_confidence\_interval - + return value\_confidence\_interval **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.mdx index fe9b12ced34..e630d32e5a5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # qiskit.aqua.algorithms.LinearsolverResult - + Linear solver Result. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 5956f87cf12..f7a68685d01 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation - + The Maximum Likelihood Amplitude Estimation algorithm. This class implements the quantum amplitude estimation (QAE) algorithm without phase estimation, as introduced in \[1]. In comparison to the original QAE algorithm \[2], this implementation relies solely on different powers of the Grover operator and does not require additional evaluation qubits. Finally, the estimate is determined via a maximum likelihood estimation, which is why this class in named `MaximumLikelihoodAmplitudeEstimation`. @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### a\_factory - + Get the A operator encoding the amplitude a that’s approximated, i.e. > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### grover\_operator - + Get the $\mathcal{Q}$ operator, or Grover operator. If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### i\_objective - + Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping > A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1> @@ -211,7 +211,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### objective\_qubits - + Get the criterion for a measurement outcome to be in a ‘good’ state. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### q\_factory - + Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e. $$ @@ -265,7 +265,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** @@ -275,7 +275,7 @@ $$ ### random - + Return a numpy random. @@ -314,7 +314,7 @@ $$ ### state\_preparation - + Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 906324e009b..5b52cbed115 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult - + MaximumLikelihoodAmplitudeEstimation Result. ### \_\_init\_\_ @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### a\_estimation - + return a\_estimation **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### circuit\_results - + return circuit results **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### confidence\_interval - + return confidence\_interval **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### estimation - + return estimation **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fisher\_information - + return fisher\_information **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### num\_oracle\_queries - + return num\_oracle\_queries **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### theta - + returns theta **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.mdx index b6c140be94f..8029dc3fd04 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # qiskit.aqua.algorithms.MinimumEigensolver - + The Minimum Eigensolver Interface. Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -36,7 +36,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index 2bde057521c..9d12d47da10 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # qiskit.aqua.algorithms.MinimumEigensolverResult - + Minimum Eigensolver Result. ### \_\_init\_\_ @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 3ef6ca0060a..e4e7dccc595 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # qiskit.aqua.algorithms.NumPyEigensolver - + The NumPy Eigensolver algorithm. NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued square matrix of dimension $n \times n$, with $k \leq n$. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + Return the operator. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### random - + Return a numpy random. @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 4137b98fa34..ab6429e5780 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # qiskit.aqua.algorithms.NumPyLSsolver - + The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 566acdf6ce2..2cd0965e0a8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # qiskit.aqua.algorithms.NumPyLSsolverResult - + Numpy LinearSystem Result. ### \_\_init\_\_ @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### eigvals - + return eigvals **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### solution - + return solution **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7d9471a3152..da3bb41909b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # qiskit.aqua.algorithms.NumPyMinimumEigensolver - + The Numpy Minimum Eigensolver algorithm. **Parameters** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### random - + Return a numpy random. @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.mdx index 6db057482a9..9d457d3345b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # qiskit.aqua.algorithms.QAOA - + The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_state - + Returns: Returns the initial state. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### mixer - + Returns: Returns the mixer. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### random - + Return a numpy random. @@ -381,13 +381,13 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -403,7 +403,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.mdx index bde7b216d3e..a4640bfb4db 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # qiskit.aqua.algorithms.QGAN - + The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### d\_loss - + Returns discriminator loss **Return type** @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### discriminator - + Returns discriminator ### g\_loss - + Returns generator loss **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### generator - + Returns generator @@ -144,7 +144,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** @@ -154,13 +154,13 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### random - + Return a numpy random. ### rel\_entr - + Returns relative entropy between target and trained distribution **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### seed - + Returns random seed @@ -236,7 +236,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### tol\_rel\_ent - + Returns tolerance for relative entropy diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.mdx index 6c9e148847b..58d9d250342 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # qiskit.aqua.algorithms.QPE - + The Quantum Phase Estimation algorithm. QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two quantum registers, **control** and **target**, where the control consists of several qubits initially put in uniform superposition, and the target a set of qubits prepared in an eigenstate (often a guess of the eigenstate) of the unitary operator of a quantum system. QPE then evolves the target under the control using dynamics on the unitary operator. The information of the corresponding eigenvalue is then ‘kicked-back’ into the phases of the control register, which can then be deconvoluted by an Inverse Quantum Fourier Transform (IQFT), and measured for read-out in binary decimal format. QPE also requires a reasonably good estimate of the eigen wave function to start the process. For example, when estimating molecular ground energies in chemistry, the Hartree-Fock method could be used to provide such trial eigen wave functions. @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### random - + Return a numpy random. @@ -180,7 +180,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.mdx index 32742d729af..26b863c939f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # qiskit.aqua.algorithms.QSVM - + Quantum SVM algorithm. A key concept in classification methods is that of a kernel. Data cannot typically be separated by a hyperplane in its original space. A common technique used to find such a hyperplane consists on applying a non-linear transformation function to the data. This function is called a *feature map*, as it transforms the raw features, or measurable properties, of the phenomenon or subject under study. Classifying in this new feature space – and, as a matter of fact, also in any other space, including the raw original one – is nothing more than seeing how close data points are to each other. This is the same as computing the inner product for each pair of data in the set. In fact we do not need to compute the non-linear feature map for each datum, but only the inner product of each pair of data points in the new feature space. This collection of inner products is called the **kernel** and it is perfectly possible to have feature maps that are hard to compute but whose kernels are not. @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### backend - + Returns backend. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** @@ -211,13 +211,13 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 8d7434818c7..8fff26c125c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # qiskit.aqua.algorithms.QuantumAlgorithm - + Base class for Quantum Algorithms. This method should initialize the module and use an exception if a component of the module is available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.mdx index 8a1addbcac2..aa0bdfe3ce4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # qiskit.aqua.algorithms.Shor - + Shor’s factoring algorithm. Shor’s Factoring algorithm is one of the most well-known quantum algorithms and finds the prime factors for input integer $N$ in polynomial time. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.mdx index 02fd7514957..52cee62018b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # qiskit.aqua.algorithms.Simon - + The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### random - + Return a numpy random. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.mdx index 8442c69cdc2..2b3cd189861 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # qiskit.aqua.algorithms.SklearnSVM - + The Sklearn SVM algorithm (classical). This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### class\_to\_label - + returns class to label ### label\_to\_class - + returns label to class @@ -112,13 +112,13 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM ### random - + Return a numpy random. ### ret - + returns result diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.mdx index e407ef511ec..dd6068fd946 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # qiskit.aqua.algorithms.VQC - + The Variational Quantum Classifier algorithm. Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### class\_to\_label - + returns class to label @@ -161,13 +161,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### datapoints - + return data points ### feature\_map - + Return the feature map. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### label\_to\_class - + returns label to class @@ -261,13 +261,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -308,13 +308,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### random - + Return a numpy random. ### ret - + returns result @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### test\_dataset - + returns test dataset @@ -400,13 +400,13 @@ python_api_name: qiskit.aqua.algorithms.VQC ### training\_dataset - + returns training dataset ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.mdx index 5858de9ca78..3fa09a819db 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # qiskit.aqua.algorithms.VQE - + The Variational Quantum Eigensolver algorithm. [VQE](https://arxiv.org/abs/1304.3061) is a hybrid algorithm that uses a variational technique and interleaves quantum and classical computations in order to find the minimum eigenvalue of the Hamiltonian $H$ of a given system. @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -256,7 +256,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -310,7 +310,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### random - + Return a numpy random. @@ -359,13 +359,13 @@ python_api_name: qiskit.aqua.algorithms.VQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -381,7 +381,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.mdx index b0b7def3bba..8f044e16bee 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # qiskit.aqua.circuits.CNF - + Class for constructing circuits for Conjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.CNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.CNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.mdx index 60722895645..ed1b17ee960 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # qiskit.aqua.circuits.DNF - + Class for constructing circuits for Disjunctive Normal Forms Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.DNF ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -103,25 +103,25 @@ python_api_name: qiskit.aqua.circuits.DNF ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.mdx index 39accb7c113..dc04485582a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # qiskit.aqua.circuits.ESOP - + Class for constructing circuits for Exclusive Sum of Products Constructor. @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.circuits.ESOP ### ancillary\_register - + returns ancillary register ### clause\_register - + returns clause register @@ -105,25 +105,25 @@ python_api_name: qiskit.aqua.circuits.ESOP ### num\_clauses - + returns num clauses ### num\_variables - + return num variables ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index fe33c11495f..a79c9488078 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # qiskit.aqua.circuits.PhaseEstimationCircuit - + Quantum Phase Estimation Circuit. **Parameters** @@ -72,13 +72,13 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### ancillary\_register - + returns ancillary register ### auxiliary\_register - + returns auxiliary register @@ -112,7 +112,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit ### state\_register - + returns state register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.mdx index c67dcb3cd56..a9d6dfe55ee 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # qiskit.aqua.circuits.StateVectorCircuit - + Arbitrary State-Vector Circuit. Constructor. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.mdx index 5b275bb3535..263261e906a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # qiskit.aqua.circuits.WeightedSumOperator - + Adds q^T \* w to separate register for non-negative integer weights w. Computes the weighted sum controlled by state qubits @@ -161,31 +161,31 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits ### num\_carry\_qubits - + returns num carry qubits ### num\_state\_qubits - + returns num state qubits ### num\_sum\_qubits - + returns num sum qubits ### num\_target\_qubits - + Returns the number of target qubits @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### weights - + returns weights diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.mdx index 570312bdb3b..c841ee04b7f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # qiskit.aqua.components.eigs.Eigenvalues - + Base class for eigenvalue estimation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.mdx index 1d94727e0b7..a000ed40f95 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # qiskit.aqua.components.eigs.EigsQPE - + Eigenvalues using Quantum Phase Estimation. Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.mdx index 4b489a699f9..b4939e34896 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # qiskit.aqua.components.feature\_maps.FeatureMap - + Base class for FeatureMap. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -58,31 +58,31 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index a9409dc9d07..4ca15fe4605 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # qiskit.aqua.components.feature\_maps.RawFeatureVector - + Raw Feature Vector feature map. The Raw Feature Vector can be directly used as a feature map, where the raw feature vectors will be automatically padded with ending 0s as necessary, to make sure vector length is a power of 2, and normalized such that it can be treated and used as an initial quantum state vector. @@ -69,31 +69,31 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### feature\_dimension - + returns feature dimension ### get\_entangler\_map - + get entangle map ### num\_qubits - + returns number of qubits ### support\_parameterized\_circuit - + returns whether or not the sub-class support parameterized circuit ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.mdx index 6510698a98a..aff22f669fe 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # qiskit.aqua.components.initial\_states.Custom - + The custom initial state. A custom initial state can be created with this component. It allows a state to be defined in the form of custom probability distribution with the *state\_vector*, or by providing a desired *circuit* to set the state. @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.mdx index 1c371ffad98..8dcee7e91fb 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # qiskit.aqua.components.initial\_states.InitialState - + Base class for InitialState. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -34,11 +34,11 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### bitstr - + ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.mdx index 57a9002c711..509eca8b2e4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # qiskit.aqua.components.initial\_states.VarFormBased - + The variational form based initial state. This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.mdx index b51ef7cc33e..cd6b622ed1f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # qiskit.aqua.components.initial\_states.Zero - + The zero (null/vacuum) state. This is suitable for those situations in which the all-zeros state is the desired state. This is the case for a *vacuum state* in physics or chemistry @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero ### bitstr - + ### construct\_circuit diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 23d339ab751..a6cc6497dc0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # qiskit.aqua.components.multiclass\_extensions.AllPairs - + The All-Pairs multiclass extension. In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a $k$-way multiclass problem; each receives the samples of a pair of classes from the original training set, and must learn to distinguish these two classes. At prediction time, a **weighted voting scheme** is used: all $k(k−1)/2$ classifiers are applied to an unseen sample, and each class gets assigned the sum of all the scores obtained by the various classifiers. The combined classifier returns as a result the class getting the highest value. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index cd12c28cb2c..0d57860c84d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # qiskit.aqua.components.multiclass\_extensions.ErrorCorrectingCode - + The Error Correcting Code multiclass extension. Error Correcting Code (ECC) is an ensemble method designed for the multiclass classification problem. As for the other multiclass methods, the task is to decide one label from $k > 2$ possible choices. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 2129162570a..bbdabbf6272 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # qiskit.aqua.components.multiclass\_extensions.MulticlassExtension - + Base class for multiclass extension. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index 33bb508dbbc..865bfb28bc6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # qiskit.aqua.components.multiclass\_extensions.OneAgainstRest - + The One Against Rest multiclass extension. For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM classifiers, with the $i$-th classifier separating class $i$ from all the remaining classes, $\forall i \in \{1, 2, \ldots, n\}$. When the $n$ classifiers are combined to make the final decision, the classifier that generates the highest value from its decision function is selected as the winner and the corresponding class label is returned. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index a45c778e813..2527bbad171 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # qiskit.aqua.components.neural\_networks.DiscriminativeNetwork - + Base class for discriminative Quantum or Classical Neural Networks. This method should initialize the module but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index f6cdba6d88e..73ee445876a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # qiskit.aqua.components.neural\_networks.GenerativeNetwork - + Base class for generative Quantum and Classical Neural Networks. This method should initialize the module, but raise an exception if a required component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -58,13 +58,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### parameter\_values - + Get parameter values from the generator **Raises** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_discriminator - + Set discriminator network. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 40fb17633a9..f3848f3ef64 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # qiskit.aqua.components.neural\_networks.NumPyDiscriminator - + Discriminator based on NumPy **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 823ede5c275..0a05effe1d3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # qiskit.aqua.components.neural\_networks.PyTorchDiscriminator - + Discriminator based on PyTorch **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator ### discriminator\_net - + Get discriminator **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index f732cfcf18a..4c2fae2b47c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # qiskit.aqua.components.neural\_networks.QuantumGenerator - + Quantum Generator. The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### discriminator - + Get discriminator. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### optimizer - + Get optimizer. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### parameter\_values - + Get parameter values from the quantum generator **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator ### seed - + Get seed. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.mdx index ef0b3809602..d543488872d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # qiskit.aqua.components.optimizers.ADAM - + Adam and AMSGRAD optimizers. Adam \[1] is a gradient-based optimization algorithm that is relies on adaptive estimates of lower-order moments. The algorithm requires little memory and is invariant to diagonal rescaling of the gradients. Furthermore, it is able to cope with non-stationary objective functions and noisy and/or sparse gradients. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### bounds\_support\_level - + Returns bounds support level @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,67 +122,67 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -292,13 +292,13 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.mdx index 0731c83bfb1..5f0039e33cf 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # qiskit.aqua.components.optimizers.AQGD - + Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: * K. Mitarai, M. Negoro, M. Kitagawa, and K. Fujii. (2018). Quantum circuit learning. Phys. Rev. A 98, 032309. [https://arxiv.org/abs/1803.00745](https://arxiv.org/abs/1803.00745) @@ -87,7 +87,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### bounds\_support\_level - + Returns bounds support level @@ -109,7 +109,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,67 +130,67 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -248,13 +248,13 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.mdx index fd229abcf44..2fe30b6a348 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # qiskit.aqua.components.optimizers.BOBYQA - + Bound Optimization BY Quadratic Approximation algorithm. BOBYQA finds local solutions to nonlinear, non-convex minimization problems with optional bound constraints, without requirement of derivatives of the objective function. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.mdx index c5fd74e0b3d..55991c45ef6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # qiskit.aqua.components.optimizers.CG - + Conjugate Gradient optimizer. CG is an algorithm for the numerical solution of systems of linear equations whose matrices are symmetric and positive-definite. It is an *iterative algorithm* in that it uses an initial guess to generate a sequence of improving approximate solutions for a problem, in which each approximation is derived from the previous ones. It is often used to solve unconstrained optimization problems, such as energy minimization. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.mdx index 499e3a0dcc4..cf92c2aa1f5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # qiskit.aqua.components.optimizers.COBYLA - + Constrained Optimization By Linear Approximation optimizer. COBYLA is a numerical optimization method for constrained problems where the derivative of the objective function is not known. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.mdx index 4038d116bc6..6af8a69bb30 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # qiskit.aqua.components.optimizers.CRS - + Controlled Random Search (CRS) with local mutation optimizer. Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8590001ac6e..c366c241344 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # qiskit.aqua.components.optimizers.DIRECT\_L - + DIviding RECTangles Locally-biased optimizer. DIviding RECTangles (DIRECT) is a deterministic-search algorithms based on systematic division of the search domain into increasingly smaller hyper-rectangles. The DIRECT-L version is a “locally biased” variant of DIRECT that makes the algorithm more biased towards local search, so that it is more efficient for functions with few local minima. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 5604b313590..24b96919ef5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # qiskit.aqua.components.optimizers.DIRECT\_L\_RAND - + DIviding RECTangles Locally-biased Randomized optimizer. DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.mdx index 469f5723bea..2104a1dfbb2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # qiskit.aqua.components.optimizers.ESCH - + ESCH evolutionary optimizer. ESCH is an evolutionary algorithm for global optimization that supports bound constraints only. Specifically, it does not support nonlinear constraints. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### bounds\_support\_level - + Returns bounds support level @@ -93,7 +93,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,67 +114,67 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -228,13 +228,13 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.mdx index 333de2bed74..f5709158210 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # qiskit.aqua.components.optimizers.GSLS - + Gaussian-smoothed Line Search. An implementation of the line search algorithm described in [https://arxiv.org/pdf/1905.01332.pdf](https://arxiv.org/pdf/1905.01332.pdf), using gradient approximation based on Gaussian-smoothed samples on a sphere. @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### bounds\_support\_level - + Returns bounds support level @@ -127,7 +127,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -148,67 +148,67 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -340,13 +340,13 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.mdx index 397d9b5d42f..6189dd64722 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # qiskit.aqua.components.optimizers.IMFIL - + IMplicit FILtering algorithm. Implicit filtering is a way to solve bound-constrained optimization problems for which derivatives are not available. In comparison to methods that use interpolation to reconstruct the function and its higher derivatives, implicit filtering builds upon coordinate search followed by interpolation to get an approximate gradient. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -197,13 +197,13 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.mdx index dba0fd9ba85..787d714a167 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # qiskit.aqua.components.optimizers.ISRES - + Improved Stochastic Ranking Evolution Strategy optimizer. Improved Stochastic Ranking Evolution Strategy (ISRES) is an algorithm for non-linearly constrained global optimization. It has heuristics to escape local optima, even though convergence to a global optima is not guaranteed. The evolution strategy is based on a combination of a mutation rule and differential variation. The fitness ranking is simply via the objective function for problems without nonlinear constraints. When nonlinear constraints are included, the [stochastic ranking proposed by Runarsson and Yao](https://notendur.hi.is/tpr/software/sres/Tec311r.pdf) is employed. This method supports arbitrary nonlinear inequality and equality constraints, in addition to the bound constraints. @@ -69,7 +69,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### bounds\_support\_level - + Returns bounds support level @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,67 +112,67 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -226,13 +226,13 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index c71bf7bd60b..48781e0581f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # qiskit.aqua.components.optimizers.L\_BFGS\_B - + Limited-memory BFGS Bound optimizer. The target goal of Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B) is to minimize the value of a differentiable scalar function $f$. This optimizer is a quasi-Newton method, meaning that, in contrast to Newtons’s method, it does not require $f$’s Hessian (the matrix of $f$’s second derivatives) when attempting to compute $f$’s minimum value. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index e6d33b5e282..135243451c7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # qiskit.aqua.components.optimizers.NELDER\_MEAD - + Nelder-Mead optimizer. The Nelder-Mead algorithm performs unconstrained optimization; it ignores bounds or constraints. It is used to find the minimum or maximum of an objective function in a multidimensional space. It is based on the Simplex algorithm. Nelder-Mead is robust in many applications, especially when the first and second derivatives of the objective function are not known. @@ -72,7 +72,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### bounds\_support\_level - + Returns bounds support level @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,67 +105,67 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -219,13 +219,13 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.mdx index 8227d7f2657..89bf21aadaf 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # qiskit.aqua.components.optimizers.NFT - + Nakanishi-Fujii-Todo algorithm. See [https://arxiv.org/abs/1903.12166](https://arxiv.org/abs/1903.12166) @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### bounds\_support\_level - + Returns bounds support level @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,67 +121,67 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -235,13 +235,13 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.mdx index 0d1f3c01877..e9ac0f94c38 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # qiskit.aqua.components.optimizers.Optimizer - + Base class for optimization algorithm. Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. ### \_\_init\_\_ - + Initialize the optimization algorithm, setting the support level for \_gradient\_support\_level, \_bound\_support\_level, \_initial\_point\_support\_level, and empty options. @@ -52,19 +52,19 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### bounds\_support\_level - + Returns bounds support level ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -85,73 +85,73 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported ### optimize - + Perform optimization. **Parameters** @@ -199,13 +199,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 275f472c907..bee2a0085c6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # qiskit.aqua.components.optimizers.OptimizerSupportLevel - + Support Level enum for features such as bounds, gradient and initial point ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.mdx index ad3ccd73021..560a4a48ac2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # qiskit.aqua.components.optimizers.POWELL - + Powell optimizer. The Powell algorithm performs unconstrained optimization; it ignores bounds or constraints. Powell is a *conjugate direction method*: it performs sequential one-dimensional minimization along each directional vector, which is updated at each iteration of the main minimization loop. The function being minimized need not be differentiable, and no derivatives are taken. @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### bounds\_support\_level - + Returns bounds support level @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,67 +101,67 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -215,13 +215,13 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.mdx index 0aea4556549..46f960acb37 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # qiskit.aqua.components.optimizers.P\_BFGS - + Parallelized Limited-memory BFGS optimizer. P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. @@ -66,7 +66,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### bounds\_support\_level - + Returns bounds support level @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -99,67 +99,67 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -213,13 +213,13 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.mdx index 7a58312796e..dbf3bd6ae15 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # qiskit.aqua.components.optimizers.SLSQP - + Sequential Least SQuares Programming optimizer. SLSQP minimizes a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft. @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### bounds\_support\_level - + Returns bounds support level @@ -82,7 +82,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,67 +103,67 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -217,13 +217,13 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.mdx index f3811b85da2..bdbe0897f01 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # qiskit.aqua.components.optimizers.SNOBFIT - + Stable Noisy Optimization by Branch and FIT algorithm. SnobFit is used for the optimization of derivative-free, noisy objective functions providing robust and fast solutions of problems with continuous variables varying within bound. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -203,13 +203,13 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.mdx index d9e1bb08faf..b1b4f2a2d4f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # qiskit.aqua.components.optimizers.SPSA - + Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. SPSA is an algorithmic method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization. @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### bounds\_support\_level - + Returns bounds support level @@ -102,7 +102,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -123,67 +123,67 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -237,13 +237,13 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.mdx index 597a684e2ba..e7fc949f6c2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # qiskit.aqua.components.optimizers.TNC - + Truncated Newton (TNC) optimizer. TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### bounds\_support\_level - + Returns bounds support level @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,67 +107,67 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_support\_level - + Returns gradient support level ### initial\_point\_support\_level - + Returns initial point support level ### is\_bounds\_ignored - + Returns is bounds ignored ### is\_bounds\_required - + Returns is bounds required ### is\_bounds\_supported - + Returns is bounds supported ### is\_gradient\_ignored - + Returns is gradient ignored ### is\_gradient\_required - + Returns is gradient required ### is\_gradient\_supported - + Returns is gradient supported ### is\_initial\_point\_ignored - + Returns is initial point ignored ### is\_initial\_point\_required - + Returns is initial point required ### is\_initial\_point\_supported - + Returns is initial point supported @@ -221,13 +221,13 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### setting - + Return setting ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index e3942f76ec3..85caa6d3eb4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # qiskit.aqua.components.oracles.CustomCircuitOracle - + The Custom Circuit-based Quantum Oracle. A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. @@ -69,13 +69,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -93,13 +93,13 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 3c4f757da7f..225d8475579 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # qiskit.aqua.components.oracles.LogicalExpressionOracle - + The Logical Expression Quantum Oracle. The Logical Expression Oracle, as its name suggests, constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR), as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) ^ (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -80,13 +80,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -102,13 +102,13 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.mdx index 4115a2a9516..db9a3fc404d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # qiskit.aqua.components.oracles.Oracle - + Base class for oracles. This method should initialize the module and use an exception if a component of the module is not available. @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -42,17 +42,17 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit - + Construct the oracle circuit. **Returns** @@ -62,13 +62,13 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b568f4c946e..6e67e33a39a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # qiskit.aqua.components.oracles.TruthTableOracle - + The Truth Table-based Quantum Oracle. Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### ancillary\_register - + returns ancillary register ### circuit - + ### construct\_circuit @@ -90,13 +90,13 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle ### output\_register - + returns output register ### variable\_register - + returns variable register diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.mdx index 12733381322..24685415d29 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # qiskit.aqua.components.reciprocals.LongDivision - + The Long Division Rotation for Reciprocals. This method calculates inverse of eigenvalues using binary long division and performs the corresponding rotation. Long division is implemented as a sequence of subtraction (utilizing ripple carry adder module) and bit shifting. The method allows for adjusting of the reciprocal precision by changing number of iterations. The method was optimized for register conventions used in HHL algorithm (i.e. eigenvalues rescaled to values between 0 and 1). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.mdx index 81ea9c033da..417d4781447 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # qiskit.aqua.components.reciprocals.LookupRotation - + The Lookup Rotation for Reciprocals. This method applies a variable sized binning to the values. Only a specified number of bits after the most-significant bit is taken into account when assigning rotation angles to the numbers prepared as states in the input register. Using precomputed angles, the reciprocal is multiplied to the amplitude via controlled rotations. While no resolution of the result is lost for small values, towards larger values the bin size increases. The accuracy of the result is tuned by the parameters. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 557c97bc0a2..738b9c885b1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # qiskit.aqua.components.reciprocals.Reciprocal - + Base class for reciprocal calculation. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index 6a50517d42c..27020a2a802 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # qiskit.aqua.components.uncertainty\_models.BernoulliDistribution - + The Univariate Bernoulli Distribution. Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit. @@ -142,35 +142,35 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### p - + ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### probabilities - + returns probabilities @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 22f28459568..21814d6362d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # qiskit.aqua.components.uncertainty\_models.GaussianConditionalIndependenceModel - + The Gaussian Conditional Independence Model for Credit Risk. Reference: [https://arxiv.org/abs/1412.1183](https://arxiv.org/abs/1412.1183) @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### dimension - + returns dimensions @@ -158,49 +158,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 8d3315a2130..5f2b33ad2a4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # qiskit.aqua.components.uncertainty\_models.LogNormalDistribution - + The Univariate Log-Normal Distribution. Log-normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index c0b41887189..51fef3b7216 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # qiskit.aqua.components.uncertainty\_models.MultivariateDistribution - + This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index eeb289bbe79..5b097bc040f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # qiskit.aqua.components.uncertainty\_models.MultivariateLogNormalDistribution - + The Multivariate Log-Normal Distribution. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### dimension - + returns dimensions @@ -152,49 +152,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 528b48c7586..23cf44e5f64 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # qiskit.aqua.components.uncertainty\_models.MultivariateNormalDistribution - + The Multivariate Normal Distribution. Provides a discretized and truncated normal distribution loaded into a quantum state. Truncation bounds are given by lower and upper bound and discretization is specified by the number of qubits per dimension. @@ -136,7 +136,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### dimension - + returns dimensions @@ -154,49 +154,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 830531fd516..51c9f5cc508 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution - + The Multivariate Uniform Distribution. Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application. @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### dimension - + returns dimensions @@ -150,49 +150,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index b3e63aba43e..b160ede9953 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # qiskit.aqua.components.uncertainty\_models.MultivariateVariationalDistribution - + The Multivariate Variational Distribution. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### dimension - + returns dimensions @@ -153,49 +153,49 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### high - + returns high ### low - + returns low ### num\_qubits - + returns num qubits ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + pdf to probabilities ### probabilities - + returns probabilities ### probabilities\_vector - + returns probabilities vector @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 46c3114ba4b..2dd748bb414 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # qiskit.aqua.components.uncertainty\_models.NormalDistribution - + The Univariate Normal Distribution. Normal distribution, truncated to lower and upper bound and discretized on a grid defined by the number of qubits. @@ -145,31 +145,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### probabilities - + returns probabilities @@ -208,7 +208,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index e526ca3b43f..afbc8f9571e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # qiskit.aqua.components.uncertainty\_models.UncertaintyModel - + The abstract Uncertainty Model ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index 10ecbbbfbed..69cadc04f36 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # qiskit.aqua.components.uncertainty\_models.UniformDistribution - + The Univariate Uniform Distribution. Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval. @@ -141,31 +141,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### probabilities - + returns probabilities @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index 5a533bc58a2..316c48d150c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # qiskit.aqua.components.uncertainty\_models.UnivariateDistribution - + This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) **Parameters** @@ -149,31 +149,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### probabilities - + returns probabilities @@ -212,7 +212,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index a364b9274d4..cc7e1006e8b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # qiskit.aqua.components.uncertainty\_models.UnivariateVariationalDistribution - + The Univariate Variational Distribution. **Parameters** @@ -144,31 +144,31 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### high - + returns high ### low - + returns low ### num\_target\_qubits - + Returns the number of target qubits ### num\_values - + returns number of values ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### probabilities - + returns probabilities @@ -217,7 +217,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### values - + returns values diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index 1c741bf2770..c6ab224913b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # qiskit.aqua.components.uncertainty\_problems.MultivariateProblem - + Multivariate Uncertainty Problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index 0e99e008c48..8c02d908cb8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # qiskit.aqua.components.uncertainty\_problems.UncertaintyProblem - + The abstract Uncertainty Problem component. ### \_\_init\_\_ @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 5ac5955c5f7..0eeb0cb862f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # qiskit.aqua.components.uncertainty\_problems.UnivariatePiecewiseLinearObjective - + Univariate Piecewise Linear Objective Function. This objective function applies controlled Y-rotation to the target qubit, where the control qubits represent integer value, and rotation approximates a piecewise linear function of the amplitude f: @@ -156,7 +156,7 @@ $$ ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index ccb460fb0f1..4b9b92d7e2a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # qiskit.aqua.components.uncertainty\_problems.UnivariateProblem - + Univariate uncertainty problem. Constructor. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 0678df8bfc8..7007118837f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # qiskit.aqua.components.variational\_forms.VariationalForm - + Base class for VariationalForms. This method should initialize the module and use an exception if a component of the module is not available. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -60,13 +60,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### parameter\_bounds - + Parameter bounds. **Returns** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -116,11 +116,11 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.mdx index 4787352dbf8..bc4da1df0d2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.OperatorBase # qiskit.aqua.operators.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms in Aqua. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -139,7 +139,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -177,7 +177,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -209,7 +209,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -223,13 +223,13 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -269,7 +269,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -315,7 +315,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -333,7 +333,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -353,7 +353,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 933592cb462..7ebc23253d9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # qiskit.aqua.operators.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.mdx index 5baddfcd2da..34fb0135015 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # qiskit.aqua.operators.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.mdx index 7d7dd8b170e..fa26b966c60 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # qiskit.aqua.operators.converters.ConverterBase - + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index fc1aa54d7cf..a0e101f50fc 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # qiskit.aqua.operators.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 898ddc4fdb9..e7b77dd00f0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # qiskit.aqua.operators.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index a427ad49246..10782a3f3c5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # qiskit.aqua.operators.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index e463579330b..3e5ea422e91 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # qiskit.aqua.operators.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 6671c0f0f55..c828cc94cad 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # qiskit.aqua.operators.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -318,7 +318,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index 286379421e5..d956a66efe0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # qiskit.aqua.operators.evolutions.MatrixEvolution - + Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index fe260118b9c..b33caa97fda 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # qiskit.aqua.operators.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.mdx index a777c872bc0..1493bf248e3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # qiskit.aqua.operators.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.mdx index ca0e463ca78..86b630b7026 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # qiskit.aqua.operators.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.mdx index f15b03435a4..480f6d58bd3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # qiskit.aqua.operators.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index cf919be5d48..361cbcf46fb 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # qiskit.aqua.operators.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 5e1f161079f..e69c3dedc31 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # qiskit.aqua.operators.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index 6999acf26ea..51f3206af90 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # qiskit.aqua.operators.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index 8e7df6d553f..4f5d780842c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # qiskit.aqua.operators.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 6c707d3988a..2f2707fcc05 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # qiskit.aqua.operators.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index f371ab0f386..dd297a5dfb3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # qiskit.aqua.operators.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index b2d0f7f4fc6..dcd55e48373 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # qiskit.aqua.operators.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.mdx index f4ae2b360d4..eaa155c0007 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # qiskit.aqua.operators.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a5ed172688b..7a8b5fd47e6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # qiskit.aqua.operators.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 8c3cd57f155..d49eded58c7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # qiskit.aqua.operators.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.mdx index cd28266e80e..f35162560af 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # qiskit.aqua.operators.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.mdx index 6ce8fd8a006..c14b662068b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # qiskit.aqua.operators.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.mdx index d565bbe49b5..7f41eb6829f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # qiskit.aqua.operators.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.mdx index 228cd12c85b..e8a0930eb53 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # qiskit.aqua.operators.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.mdx index 523cf619b37..f9876785c80 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # qiskit.aqua.operators.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -92,7 +92,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.mdx index 29a31c4ad41..d32a409297e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # qiskit.aqua.operators.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -146,7 +146,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.mdx index 7b013ca4d6e..da7ce1abd05 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # qiskit.aqua.operators.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parametrized quantum state, where QFI is: @@ -93,7 +93,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -112,7 +112,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.mdx index 613712d91a6..bfc269a4012 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # qiskit.aqua.operators.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parametrized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index c2f2beb55c0..bb98926c622 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,14 +8,14 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # qiskit.aqua.operators.legacy.LegacyBaseOperator - + Operators relevant for quantum applications. Constructor. ### \_\_init\_\_ - + Constructor. @@ -43,65 +43,65 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### basis - + returns basis ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### name - + returns name ### num\_qubits - + Returns number of qubits for operator ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 8cc914ff1bb..33e330bfa3c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # qiskit.aqua.operators.legacy.MatrixOperator - + Operators relevant for quantum applications @@ -71,13 +71,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### atol - + return atol ### basis - + returns basis @@ -131,13 +131,13 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### dense\_matrix - + Getter of matrix in dense matrix form. ### dia\_matrix - + diagonal matrix @@ -229,19 +229,19 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### matrix - + Getter of matrix. ### name - + returns name ### num\_qubits - + number of qubits required for the operator. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.mdx index 924e12d688d..5de75ef72ea 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # qiskit.aqua.operators.legacy.PauliGraph - + Pauli Graph. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph ### grouped\_paulis - + Getter of grouped Pauli list. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index e95b8cffdc7..b093ac18b44 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator - + TPB Grouped Weighted Pauli Operator **Parameters** @@ -108,13 +108,13 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -349,7 +349,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -368,7 +368,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -392,7 +392,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### grouping\_func - + returns grouping function @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### kwargs - + returns kwargs @@ -438,19 +438,19 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### name - + returns name ### num\_groups - + returns number of groups ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -464,7 +464,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### paulis - + get paulis @@ -539,7 +539,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -607,7 +607,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** @@ -625,7 +625,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 410f6d99cf1..1d422f494e1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # qiskit.aqua.operators.legacy.WeightedPauliOperator - + Weighted Pauli Operator **Parameters** @@ -99,13 +99,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### atol - + get atol ### basis - + returns basis @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -340,7 +340,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -415,13 +415,13 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### name - + returns name ### num\_qubits - + Number of qubits required for the operator. **Returns** @@ -435,7 +435,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### paulis - + get paulis @@ -559,7 +559,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### z2\_symmetries - + returns z2 symmetries diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index c2ef9da6c81..143a95207d0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # qiskit.aqua.operators.legacy.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. **Returns** @@ -111,7 +111,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -139,19 +139,19 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -182,13 +182,13 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### tapering\_values - + returns tapering values ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.mdx index 4e03fb5a52f..e7ce512e2c8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # qiskit.aqua.operators.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -366,7 +366,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.mdx index c47867a18b2..0a7693ab4c3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # qiskit.aqua.operators.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -284,7 +284,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -350,7 +350,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.mdx index 2cdc1ee7d9e..1cc90a4070e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # qiskit.aqua.operators.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -387,7 +387,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.mdx index e746124092a..eed67051ce7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # qiskit.aqua.operators.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index 6a491e3279f..3177f692897 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # qiskit.aqua.operators.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -324,7 +324,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index ba012dc5fb2..5a627740ba5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # qiskit.aqua.operators.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -328,7 +328,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index c43d201e415..931a3f988b1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # qiskit.aqua.operators.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -286,7 +286,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -346,7 +346,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index 83a54c620f2..838e7612f3d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # qiskit.aqua.operators.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -320,7 +320,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index cefc082b6de..dfa6ef23fad 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # qiskit.aqua.operators.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -125,7 +125,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -169,7 +169,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -314,7 +314,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -412,7 +412,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index 0919f90636a..b1f641beaab 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # qiskit.aqua.operators.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -141,7 +141,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -291,7 +291,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -305,7 +305,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -347,7 +347,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.mdx index 81bf9c2c4ac..61dea24e238 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # qiskit.aqua.operators.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -210,7 +210,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -308,7 +308,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 440aea8d541..ebf15d8e7cc 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # qiskit.aqua.operators.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.mdx index 9aedab6571c..08d0478bb5a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # qiskit.aqua.operators.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -134,7 +134,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -304,7 +304,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 1a99e0ab803..46eadd524ac 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # qiskit.aqua.operators.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.mdx index 063b279fc6e..46cbc653ae5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # qiskit.aqua.utils.CircuitFactory - + Base class for CircuitFactories ### \_\_init\_\_ @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.mdx index e1eddc7d667..7a3d1096b74 100644 --- a/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # qiskit.assembler.RunConfig - + Class for Run Configuration. ### shots @@ -97,7 +97,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.mdx index ae81b901aae..d49bcf65352 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # qiskit.chemistry.BosonicOperator - + A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. References: diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.mdx index 556c2a3ff8d..707ca90e5f4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # qiskit.chemistry.FermionicOperator - + A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. References: @@ -127,13 +127,13 @@ python_api_name: qiskit.chemistry.FermionicOperator ### h1 - + Getter of one body integral tensor. ### h2 - + Getter of two body integral tensor. @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.FermionicOperator ### modes - + Getter of modes. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.mdx index c2b377d45e7..fc1c0380536 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # qiskit.chemistry.MP2Info - + A utility class for Moller-Plesset 2nd order (MP2) information Each double excitation given by \[i,a,j,b] has a coefficient computed using @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_delta - + Get the MP2 delta energy correction for the molecule **Returns** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.MP2Info ### mp2\_energy - + Get the MP2 energy for the molecule **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.mdx index 14a734d0ea7..42d44f3c935 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # qiskit.chemistry.QMolecule - + Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.QMolecule ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.QMolecule ### filename - + returns temp file path @@ -96,13 +96,13 @@ python_api_name: qiskit.chemistry.QMolecule ### one\_body\_integrals - + Returns one body electron integrals. ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -157,13 +157,13 @@ python_api_name: qiskit.chemistry.QMolecule ### two\_body\_integrals - + Returns two body electron integrals. ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -186,7 +186,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -207,23 +207,23 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ### x\_dipole\_integrals - + returns x\_dipole\_integrals ### y\_dipole\_integrals - + returns y\_dipole\_integrals ### z\_dipole\_integrals - + returns z\_dipole\_integrals diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.mdx index 45da8572dcd..ccb0d52f7a2 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.mdx index 57c3baba265..4bb91464db2 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # qiskit.chemistry.WatsonHamiltonian - + Watson Hamiltonian class containing the results of a driver’s anharmonic calculation **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### data - + Returns the matrix elements of the Hamiltonian **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian ### num\_modes - + Returns the number of modes **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.mdx index 5712c6b1d7e..10d3766d08a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # qiskit.chemistry.algorithms.AdaptVQE - + A ground state calculation employing the AdaptVQE algorithm. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.mdx index c75a433cbe4..b004204cd19 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # qiskit.chemistry.algorithms.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 1686584e54e..8f837c70792 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # qiskit.chemistry.algorithms.EigensolverFactory - + A factory to construct a eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index 8d7068dcde7..c45e4b8bb74 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # qiskit.chemistry.algorithms.ExcitedStatesEigensolver - + The calculation of excited states via an Eigensolver algorithm **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 6f28d97e44f..c9d661eb9a5 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # qiskit.chemistry.algorithms.ExcitedStatesSolver - + The excited states calculation interface ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index 049d02842ec..31a09b74c85 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # qiskit.chemistry.algorithms.GroundStateEigensolver - + Ground state computation using a minimum eigensolver. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.mdx index a002dbd0c3e..e50c38a15a1 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # qiskit.chemistry.algorithms.GroundStateSolver - + The ground state calculation interface **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index b8a0edc1c32..5d10457f982 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # qiskit.chemistry.algorithms.MinimumEigensolverFactory - + A factory to construct a minimum eigensolver based on a qubit operator transformation. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index bbd3a1ddb68..5f614a46726 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # qiskit.chemistry.algorithms.NumPyEigensolverFactory - + A factory to construct a NumPyEigensolver. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### k - + returns k (number of eigenvalues requested) **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index a4bf14b44a3..fefb70f9093 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory - + A factory to construct a NumPyMinimumEigensolver. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### filter\_criterion - + returns filter criterion **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory ### use\_default\_filter\_criterion - + returns whether to use the default filter criterion **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index e5528c63fe3..e8d5c65a150 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # qiskit.chemistry.algorithms.OrbitalOptimizationVQE - + A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### solver - + Returns the minimum eigensolver or factory. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE ### transformation - + Returns the transformation used to obtain a qubit operator from the molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.mdx index 155c7f29498..b19172b381e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # qiskit.chemistry.algorithms.QEOM - + The calculation of excited states via the qEOM algorithm **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM ### excitations - + Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.mdx index c99651d042d..f7ac0463f6b 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # qiskit.chemistry.algorithms.QEomEE - + QEomEE algorithm (classical) **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### filter\_criterion - + returns the filter criterion if set **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### random - + Return a numpy random. @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.mdx index e429ecb926b..36ba3a7482f 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # qiskit.chemistry.algorithms.QEomVQE - + QEomVQE algorithm **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### random - + Return a numpy random. @@ -371,13 +371,13 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### setting - + Prepare the setting of VQE as a string. ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. @@ -393,7 +393,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.mdx index c49597fb26e..84fcedb1479 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # qiskit.chemistry.algorithms.VQEAdapt - + DEPRECATED. The Adaptive VQE algorithm. See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -166,13 +166,13 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimal\_params - + returns optimal parameters ### optimizer - + Returns optimizer **Return type** @@ -182,7 +182,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### random - + Return a numpy random. @@ -231,7 +231,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 28a0bb2ea8a..336e3102f39 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # qiskit.chemistry.algorithms.VQEUCCSDFactory - + A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### excitation\_type - + Getter of the `excitation_type` setting for the `excitation_type` setting. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_doubles - + Getter of the `method_doubles` setting for the `method_doubles` setting. **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### method\_singles - + Getter of the `method_singles` setting for the `method_singles` setting. **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory ### same\_spin\_doubles - + Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index 56ad20a7469..544678a0c18 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # qiskit.chemistry.algorithms.VQEUVCCSDFactory - + A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### expectation - + Getter of the expectation. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### gradient - + Getter of the gradient function **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### include\_custom - + Getter of the `include_custom` setting for the `expectation` setting. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### initial\_point - + Getter of the initial point. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### optimizer - + Getter of the optimizer. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory ### quantum\_instance - + Getter of the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 443eed81800..42d93c09387 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # qiskit.chemistry.algorithms.pes\_samplers.BOPESSampler - + Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index 65d0d472d1e..8b778a0d359 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # qiskit.chemistry.algorithms.pes\_samplers.DifferentialExtrapolator - + An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. Constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 84212db2c03..76fbb133fae 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # qiskit.chemistry.algorithms.pes\_samplers.EnergySurface1DSpline - + A simple cubic spline interpolation for the potential energy surface. A spline interpolation method for data fitting. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 3e97db2bc4f..d4ffd4621d7 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # qiskit.chemistry.algorithms.pes\_samplers.EnergySurfaceBase - + Class to hold a potential energy surface ### \_\_init\_\_ @@ -30,7 +30,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -105,7 +105,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 84a5c18de02..9165093f82e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # qiskit.chemistry.algorithms.pes\_samplers.Extrapolator - + This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. Each instance of an Extrapolator requires a dictionary where each item consist of a point (key) and a list of variational parameters (value) for that given point. In practice, a Sampler Class can utilize the Extrapolator as a wrapper. The Extrapolator class then extracts optimal variational parameters from the previous points for use in extrapolation. For instance, one can utilize the Extrapolator to accelerate the computation of the Born-Oppenheimer Potential Energy Surface (BOPES) for a given molecule. In this case, each point can represent the interatomic distance and the list of parameters represent rotational parameters in a quantum circuit, in the context of computing the bond dissociation profile for a diatomic molecule. NOTE: However this is not a requirement - once an instance of the Extrapolator class is created, extrapolation can proceed by specifying the point(s) of interest and the dictionary of (point, parameter) pairs for a problem. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index 641fc6c3308..7a703d8b595 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # qiskit.chemistry.algorithms.pes\_samplers.HarmonicPotential - + Implements a 1D Harmonic potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + **Mostly for internal use. Preprocesses the data passed to fit\_to\_data()** so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 6197220d86a..141f6d4b0b6 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # qiskit.chemistry.algorithms.pes\_samplers.MorsePotential - + Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 44468f8e352..67e8ca8a7b3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PCAExtrapolator - + A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. Constructor. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index 337b214f283..3de1b074082 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.PolynomialExtrapolator - + An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -58,7 +58,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 953d1ee37a0..0250897ea92 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # qiskit.chemistry.algorithms.pes\_samplers.PotentialBase - + Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -118,7 +118,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -176,7 +176,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index 3c67abc8f76..202958a6a30 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.SieveExtrapolator - + A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. Constructor. @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index 002af5ea244..ec3bc4b8640 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # qiskit.chemistry.algorithms.pes\_samplers.VibronicStructureBase - + Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. ### \_\_init\_\_ @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 650f2acfed1..0f7dd5c2eee 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # qiskit.chemistry.algorithms.pes\_samplers.WindowExtrapolator - + An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. Constructor. @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### extrapolator - + Returns the internal extrapolator. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### window - + Returns the size of the window. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index 34e4da3f0c4..c8581e90b98 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # qiskit.chemistry.applications.MolecularGroundStateEnergy - + Molecular ground state energy chemistry application **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### driver - + Returns chemistry driver **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### solver - + Returns minimum eigen solver **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 89111f7e7a3..1c4e110e046 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # qiskit.chemistry.components.bosonic\_bases.BosonicBasis - + Basis to express a second quantization Bosonic Hamiltonian. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 4f35286f61f..dab39d88a4e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # qiskit.chemistry.components.bosonic\_bases.HarmonicBasis - + Basis in which the Watson Hamiltonian is expressed. This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) as a modal basis for the expression of the Watson Hamiltonian or any bosonic operator. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0a607b86123..a4fc9327b76 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # qiskit.chemistry.components.initial\_states.HartreeFock - + A Hartree-Fock initial state. **Parameters** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.mdx index 3573ece0570..a9ea53953b9 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # qiskit.chemistry.components.initial\_states.VSCF - + Initial state for vibrational modes. Creates an occupation number vector as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. e.g. for 2 modes with 4 modals per mode it creates: |1000 1000> @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF ### bitstr - + Getter of the bit string represented the statevector. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.mdx index 721e5653143..96e4629a59c 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # qiskit.chemistry.components.variational\_forms.CHC - + This trial wavefunction is the Compact Heuristic for Chemistry. The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. It aims at approximating the UCC Ansatz for a lower CNOT count. @@ -86,13 +86,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -142,11 +142,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.mdx index 59b6ee0d9ff..fed06dc156b 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # qiskit.chemistry.components.variational\_forms.UCCSD - + This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) Constructor. @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -209,13 +209,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### double\_excitations - + Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] ### excitation\_pool - + Returns the full list of available excitations (called the pool). **Return type** @@ -225,13 +225,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -275,7 +275,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### parameter\_bounds - + Parameter bounds. **Returns** @@ -342,7 +342,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -358,7 +358,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -382,17 +382,17 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### setting - + ### single\_excitations - + Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.mdx index b1374beb072..788145ce31e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # qiskit.chemistry.components.variational\_forms.UVCC - + This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. **Parameters** @@ -63,7 +63,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -126,13 +126,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### num\_parameters - + Number of parameters of the variational form. **Returns** @@ -146,7 +146,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### num\_qubits - + Number of qubits of the variational form. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### parameter\_bounds - + Parameter bounds. **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### preferred\_init\_points - + Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state @@ -182,11 +182,11 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### setting - + ### support\_parameterized\_circuit - + Whether or not the sub-class support parameterized circuit. **Returns** @@ -200,7 +200,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.mdx index e1aeaf92671..0dcfe95e6e0 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,12 +8,12 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # qiskit.chemistry.core.ChemistryOperator - + Base class for ChemistryOperator. ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### molecule\_info - + returns molecule info @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.mdx index 8843e492624..00d4ae27ad0 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # qiskit.chemistry.core.Hamiltonian - + A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### molecule\_info - + returns molecule info diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.mdx index 2f3b74c1c13..9960bbe4a4a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # qiskit.chemistry.core.MolecularChemistryResult - + Molecular chemistry Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 74542543f4b..9fb56ed0560 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # qiskit.chemistry.core.MolecularExcitedStatesResult - + Molecular Excited States Result Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 3beb168f157..30c91adb960 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # qiskit.chemistry.core.MolecularGroundStateResult - + Molecular Ground State Energy Result. Energies are in Hartree and dipole moments in A.U unless otherwise stated. @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -181,7 +181,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -205,7 +205,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.mdx index e4a1697a231..a9aff48d83a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # qiskit.chemistry.core.QubitMappingType - + QubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.mdx index 262ec05ebbc..58368e87694 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # qiskit.chemistry.core.TransformationType - + Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.mdx index ac19637363a..91e8c384daa 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # qiskit.chemistry.drivers.BaseDriver - + Base class for Qiskit’s chemistry drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### basis - + return basis **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### molecule - + return molecule **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.mdx index df886e5eab1..5d6330f8ca0 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # qiskit.chemistry.drivers.BasisType - + Basis Type ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.mdx index 48b7a932af8..eea5be18efe 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # qiskit.chemistry.drivers.BosonicDriver - + Base class for Qiskit’s chemistry bosonic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 2ac2ff37113..64af52d8b37 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # qiskit.chemistry.drivers.FCIDumpDriver - + Qiskit chemistry driver reading an FCIDump file. The FCIDump format is partially defined in Knowles1989. @@ -60,7 +60,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### basis - + return basis **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### molecule - + return molecule **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.mdx index 9698b0ba2e4..41f39e2dcac 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # qiskit.chemistry.drivers.FermionicDriver - + Base class for Qiskit’s chemistry fermionic drivers. **Parameters** @@ -24,7 +24,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### \_\_init\_\_ - + **Parameters** * **molecule** (`Optional`\[`Molecule`]) – molecule @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### molecule - + return molecule **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.mdx index 9ce181344d5..4b83193d6b3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # qiskit.chemistry.drivers.GaussianDriver - + Qiskit chemistry driver using the Gaussian™ 16 program. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) @@ -59,7 +59,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### basis - + return basis **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index cd7ea2d7d8f..08d46359fff 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # qiskit.chemistry.drivers.GaussianForcesDriver - + Gaussian™ 16 forces driver. **Parameters** @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 9d606b4ad1b..e36dbee06aa 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # qiskit.chemistry.drivers.GaussianLogDriver - + Gaussian™ 16 log driver. Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### basis - + return basis **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### molecule - + return molecule **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.mdx index 4d3c5a5ce94..7ee96b06672 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # qiskit.chemistry.drivers.GaussianLogResult - + Result for Gaussian™ 16 log driver. This result allows access to selected data from the log file that is not available via the use Gaussian 16 interfacing code when using the MatrixElement file. Since this parses the text output it is subject to the format of the log file. @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### a\_to\_h\_numbering - + A to H numbering mapping. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### cubic\_force\_constants - + Cubic force constants. (3 indices, 3 values) **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### log - + The complete Gaussian log in the form of a list of strings. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quadratic\_force\_constants - + Quadratic force constants. (2 indices, 3 values) **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult ### quartic\_force\_constants - + Quartic force constants. (4 indices, 3 values) **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.mdx index 3cefebe757f..948e73faea3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # qiskit.chemistry.drivers.HDF5Driver - + Qiskit chemistry driver reading an HDF5 file. The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### basis - + return basis **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### molecule - + return molecule **Return type** @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver ### work\_path - + Returns work path. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.mdx index 36c88a55523..7af31402def 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # qiskit.chemistry.drivers.HFMethodType - + HFMethodType Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.mdx index b3623aea87e..099eda4e94f 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # qiskit.chemistry.drivers.InitialGuess - + Initial Guess Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.mdx index 4736dcd3c34..adde40ac520 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # qiskit.chemistry.drivers.Molecule - + Driver-independent Molecule definition. This module implements an interface for a driver-independent, i.e. generic molecule definition. It defines the composing atoms (with properties like masses), and allows for changing the molecular geometry through given degrees of freedom (e.g. bond-stretching, angle-bending, etc.). The geometry as provided in the constructor can be affected, through setting perturbations, and it is this perturbed geometry that is supplied by the geometry getter. Setting perturbations to None will cause the original geometry to be returned, and there is a getter to get this value directly if its needed. @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -84,7 +84,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -102,7 +102,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### charge - + Get charge **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### geometry - + Get geometry accounting for any perturbations **Return type** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### masses - + Get masses **Return type** @@ -168,7 +168,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### multiplicity - + Get multiplicity **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### perturbations - + Get perturbations **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -206,7 +206,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) @@ -224,7 +224,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### units - + The geometry coordinate units diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.mdx index 3fb20d1d394..bd018fbd6f3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # qiskit.chemistry.drivers.PSI4Driver - + Qiskit chemistry driver using the PSI4 program. See [http://www.psicode.org/](http://www.psicode.org/) @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### basis - + return basis **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### hf\_method - + return Hartree-Fock method **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### molecule - + return molecule **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.mdx index b2106147207..423d3eabda9 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # qiskit.chemistry.drivers.PyQuanteDriver - + Qiskit chemistry driver using the PyQuante2 library. See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante2) @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### basis - + return basis **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### molecule - + return molecule **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.mdx index 29b4d848a11..24879916fd1 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # qiskit.chemistry.drivers.PySCFDriver - + Qiskit chemistry driver using the PySCF library. See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### basis - + return basis **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### hf\_method - + return Hartree-Fock method **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### molecule - + return molecule **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver ### supports\_molecule - + True for derived classes that support Molecule. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.mdx index f9fa0412ddf..83a3a911c16 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # qiskit.chemistry.drivers.UnitsType - + Units Type Enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.mdx index 36205b5512a..a786749378f 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # qiskit.chemistry.results.BOPESSamplerResult - + The BOPES Sampler result Creates an new instance of the result. :type points: `List`\[`float`] :param points: List of points. :type energies: `List`\[`float`] :param energies: List of energies. :type raw\_results: `Dict`\[`float`, `EigenstateResult`] :param raw\_results: Raw results obtained from the solver. @@ -36,7 +36,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### energies - + returns list of energies. **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### points - + returns list of points. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult ### raw\_results - + returns all results for all points. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.mdx index 954cc118e43..12f2c70edb4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # qiskit.chemistry.results.EigenstateResult - + The eigenstate result interface. ### \_\_init\_\_ @@ -48,7 +48,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenenergies - + returns eigen energies **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### eigenstates - + returns eigen states **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundenergy - + returns ground energy **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### groundstate - + returns ground state **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.mdx index da8d5298511..c3e8534fcb4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # qiskit.chemistry.results.ElectronicStructureResult - + The electronic structure result. ### \_\_init\_\_ @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### computed\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -174,7 +174,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### electronic\_energies - + Returns electronic part of ground state energy **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### groundstate - + returns ground state **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### magnetization - + Returns measured magnetization **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_dipole\_moment - + Returns nuclear dipole moment X,Y,Z components in A.U when available from driver **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### num\_particles - + Returns measured number of particles **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### reverse\_dipole\_sign - + Returns if electronic dipole moment sign should be reversed when adding to nuclear **Return type** @@ -376,7 +376,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### spin - + Returns computed spin **Return type** @@ -386,7 +386,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -396,7 +396,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -406,7 +406,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_dipole\_moment\_in\_debye - + Returns total dipole of moment in Debye **Return type** @@ -416,7 +416,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### total\_energies - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.mdx index a887eb829fe..c41c7b869cf 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # qiskit.chemistry.results.VibronicStructureResult - + The vibronic structure result. ### \_\_init\_\_ @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### computed\_vibronic\_energies - + Returns computed electronic part of ground state energy **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenenergies - + returns eigen energies **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### eigenstates - + returns eigen states **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### formatted - + Formatted result as a list of strings **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundenergy - + returns ground energy **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### groundstate - + returns ground state **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### num\_occupied\_modals\_per\_mode - + Returns the number of occupied modal per mode **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### raw\_result - + Returns the raw algorithm result. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 92a08ff1be8..f43a2851888 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # qiskit.chemistry.transformations.BosonicQubitMappingType - + BosonicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.mdx index 10ae059df90..2106cb09a1a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # qiskit.chemistry.transformations.BosonicTransformation - + A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### basis - + returns the basis (number of modals per mode) **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### num\_modes - + the number of modes **Type** @@ -147,7 +147,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.mdx index 3fcffefe2ae..c30b6fb37ef 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # qiskit.chemistry.transformations.BosonicTransformationType - + BosonicTransformationType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index fd03b5106aa..ffde0817035 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # qiskit.chemistry.transformations.FermionicQubitMappingType - + FermionicQubitMappingType enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.mdx index b1c59782d78..d35778e2310 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # qiskit.chemistry.transformations.FermionicTransformation - + A transformation from a fermionic problem, represented by a driver, to a qubit operator. **Parameters** @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### molecule\_info - + Getter of the molecule information. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### qubit\_mapping - + Getter of the qubit mapping. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation ### untapered\_qubit\_op - + Getter for the untapered qubit operator diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.mdx index ccd64026ceb..440aa1e271c 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # qiskit.chemistry.transformations.FermionicTransformationType - + Electronic Transformation Type enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.mdx index 169b0076a07..dae4e6f83d6 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # qiskit.chemistry.transformations.Transformation - + Base class for transformation to qubit operators for chemistry problems ### \_\_init\_\_ @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### commutation\_rule - + Getter of the commutation rule **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.mdx index 6c9539a6017..313dca39de3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # qiskit.circuit.AncillaQubit - + A qubit used as ancillary qubit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.AncillaQubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.mdx index f7acba98a61..b140f3e976b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # qiskit.circuit.AncillaRegister - + Implement an ancilla register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.AncillaRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.mdx index 0bf38a8fdac..33106942954 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # qiskit.circuit.ClassicalRegister - + Implement a classical register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Clbit.mdx index 794ec0869ca..96cec51d0c1 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # qiskit.circuit.Clbit - + Implement a classical bit. Creates a classical bit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Clbit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.mdx index 8f8d3b69389..0be1563674a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # qiskit.circuit.ControlledGate - + Controlled unitary gate. Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the gate are the controls. @@ -310,7 +310,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -320,13 +320,13 @@ python_api_name: qiskit.circuit.ControlledGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -336,7 +336,7 @@ python_api_name: qiskit.circuit.ControlledGate ### duration - + Get the duration. @@ -358,7 +358,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return instruction label **Return type** @@ -384,7 +384,7 @@ python_api_name: qiskit.circuit.ControlledGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -398,7 +398,7 @@ python_api_name: qiskit.circuit.ControlledGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.ControlledGate ### params - + Get parameters from base\_gate. **Returns** @@ -536,7 +536,7 @@ python_api_name: qiskit.circuit.ControlledGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Delay.mdx index 98db6af488f..b19c09b895a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # qiskit.circuit.Delay - + Do nothing and just delay/wait/idle for a specified duration. Create new delay instruction. @@ -109,19 +109,19 @@ python_api_name: qiskit.circuit.Delay ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration of this delay. @@ -139,7 +139,7 @@ python_api_name: qiskit.circuit.Delay ### label - + Return instruction label **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.circuit.Delay ### params - + return instruction params. @@ -251,7 +251,7 @@ python_api_name: qiskit.circuit.Delay ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.mdx index 14038c2e685..30b7f1e2065 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # qiskit.circuit.EquivalenceLibrary - + A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. Create a new equivalence library. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Gate.mdx index db40e49d914..6834c089309 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # qiskit.circuit.Gate - + Unitary gate. Create a new gate. @@ -183,19 +183,19 @@ python_api_name: qiskit.circuit.Gate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -229,7 +229,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return instruction label **Return type** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.Gate ### params - + return instruction params. @@ -367,7 +367,7 @@ python_api_name: qiskit.circuit.Gate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Instruction.mdx index 99ce9f25b1e..4fdbffc36ad 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # qiskit.circuit.Instruction - + Generic quantum instruction. Create a new instruction. @@ -136,19 +136,19 @@ python_api_name: qiskit.circuit.Instruction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -182,7 +182,7 @@ python_api_name: qiskit.circuit.Instruction ### label - + Return instruction label **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.Instruction ### params - + return instruction params. @@ -280,7 +280,7 @@ python_api_name: qiskit.circuit.Instruction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.mdx index bfd3572a6dc..354d8ece8b1 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # qiskit.circuit.InstructionSet - + Instruction collection, and their contexts. New collection of instructions. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Measure.mdx index f08a7e3ff5b..80950b9eea4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # qiskit.circuit.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.Measure ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.Measure ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Parameter.mdx index c9b0f8c3a9c..a732787d9ae 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # qiskit.circuit.Parameter - + Parameter Class for variable parameters. Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). @@ -173,13 +173,13 @@ python_api_name: qiskit.circuit.Parameter ### name - + Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.mdx index 6d8ed174ad4..bfefc1cdc94 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # qiskit.circuit.ParameterExpression - + ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). @@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.ParameterExpression ### parameters - + Returns a set of the unbound Parameters in the expression. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.mdx index deec151094f..7af4302acb3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # qiskit.circuit.ParameterVector - + ParameterVector class to quickly generate lists of parameters. ### \_\_init\_\_ @@ -40,13 +40,13 @@ python_api_name: qiskit.circuit.ParameterVector ### name - + Returns the name of the ParameterVector. ### params - + Returns the list of parameters in the ParameterVector. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.mdx index 32599571f02..5579fae8e5b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # qiskit.circuit.QuantumCircuit - + Create a new circuit. A circuit is a list of instructions bound to some registers. @@ -324,7 +324,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -486,7 +486,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -496,7 +496,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -532,19 +532,19 @@ python_api_name: qiskit.circuit.QuantumCircuit ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -763,7 +763,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### data - + Return the circuit data (instructions and context). **Returns** @@ -976,7 +976,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -994,7 +994,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1030,7 +1030,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### global\_phase - + Return the global phase of the circuit in radians. @@ -1445,7 +1445,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1459,13 +1459,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1497,13 +1497,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1679,7 +1679,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.mdx index 5fd18a493dc..e2f2b4a55fd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # qiskit.circuit.QuantumRegister - + Implement a quantum register. Create a new generic register. @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### name - + Get the register name. @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### size - + Get the register size. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Qubit.mdx index e5c8a50067a..da17f2ccda3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # qiskit.circuit.Qubit - + Implement a quantum bit. Creates a qubit. @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.Qubit ### index - + Get bit’s index. ### register - + Get bit’s register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.28/qiskit.circuit.Reset.mdx index a20a775cd87..2fbee35b276 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # qiskit.circuit.Reset - + Qubit reset. Create new reset instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.Reset ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.Reset ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 4d0afc3fada..bff06444e94 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # qiskit.circuit.classicalfunction.BooleanExpression - + The Boolean Expression gate. **Parameters** @@ -178,25 +178,25 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** @@ -242,7 +242,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### label - + Return instruction label **Return type** @@ -268,7 +268,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### params - + return instruction params. @@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index a97250a67df..c3bdb25742d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # qiskit.circuit.classicalfunction.ClassicalFunction - + Represent a classical function function and its logic network. Creates a `ClassicalFunction` from Python source code in `source`. @@ -92,7 +92,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### args - + Returns the classicalfunction arguments @@ -213,19 +213,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -259,7 +259,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### label - + Return instruction label **Return type** @@ -285,13 +285,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### network - + Returns the logical network ### params - + return instruction params. @@ -327,7 +327,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### qregs - + The list of qregs used by the classicalfunction @@ -373,7 +373,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### scopes - + Returns the scope dict @@ -470,13 +470,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### truth\_table - + Returns (and computes) the truth table ### types - + Dumps a list of scopes with their variables and types. **Returns** @@ -490,7 +490,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 85fa43af427..c731a2fba78 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index f39ddeceb16..1391defabf9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.AND.mdx index 19f47edffb3..75f2594d20f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # qiskit.circuit.library.AND - + A circuit implementing the logical AND operation on a number of qubits. For the AND operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of all variable qubits is `True`. In this format, the AND operation equals a multi-controlled X gate, which is controlled on all variable qubits. Using a list of flags however, qubits can be skipped or negated. Practically, the flags allow to skip controls or to apply pre- and post-X gates to the negated qubits. @@ -243,7 +243,7 @@ python_api_name: qiskit.circuit.library.AND ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.library.AND ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.AND ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -448,19 +448,19 @@ python_api_name: qiskit.circuit.library.AND ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -679,7 +679,7 @@ python_api_name: qiskit.circuit.library.AND ### data - + Return the circuit data (instructions and context). **Returns** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -910,7 +910,7 @@ python_api_name: qiskit.circuit.library.AND ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.AND ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ python_api_name: qiskit.circuit.library.AND ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ python_api_name: qiskit.circuit.library.AND ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ python_api_name: qiskit.circuit.library.AND ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.AND ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.mdx index 51e56f41593..eddabffe8a0 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # qiskit.circuit.library.Barrier - + Barrier instruction. Create new barrier instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Barrier ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -138,7 +138,7 @@ python_api_name: qiskit.circuit.library.Barrier ### label - + Return instruction label **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.circuit.library.Barrier ### params - + return instruction params. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.Barrier ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.mdx index 2bf73088f30..b7769b871d3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # qiskit.circuit.library.C3SXGate - + The 3-qubit controlled sqrt-X gate. This implementation is based on Page 17 of \[1]. @@ -190,7 +190,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -200,13 +200,13 @@ python_api_name: qiskit.circuit.library.C3SXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### duration - + Get the duration. @@ -234,7 +234,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### label - + Return instruction label **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -274,7 +274,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### params - + Get parameters from base\_gate. **Returns** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.C3SXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.mdx index 7030972d5a8..9bde85a4d73 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # qiskit.circuit.library.C3XGate - + The X gate controlled on 3 qubits. This implementation uses $\sqrt{T}$ and 14 CNOT gates. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -180,13 +180,13 @@ python_api_name: qiskit.circuit.library.C3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### duration - + Get the duration. @@ -214,7 +214,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return instruction label **Return type** @@ -240,7 +240,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -268,7 +268,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### params - + Get parameters from base\_gate. **Returns** @@ -392,7 +392,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.mdx index f0590c3d259..c890ee92930 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # qiskit.circuit.library.C4XGate - + The 4-qubit controlled X gate. This implementation is based on Page 21, Lemma 7.5, of \[1], with the use of the relative phase version of c3x, the rc3x \[2]. @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -184,13 +184,13 @@ python_api_name: qiskit.circuit.library.C4XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### duration - + Get the duration. @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return instruction label **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -272,7 +272,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### params - + Get parameters from base\_gate. **Returns** @@ -396,7 +396,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.mdx index 323aaa36ab5..e9be5c2d868 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # qiskit.circuit.library.CCXGate - + CCX gate, also known as Toffoli gate. **Circuit symbol:** @@ -224,7 +224,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -234,13 +234,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -250,7 +250,7 @@ $$ ### duration - + Get the duration. @@ -268,7 +268,7 @@ $$ ### label - + Return instruction label **Return type** @@ -294,7 +294,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -308,7 +308,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -322,7 +322,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -446,7 +446,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 9beaacf260f..1f1e7f2f618 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # qiskit.circuit.library.CDKMRippleCarryAdder - + A ripple-carry circuit to perform in-place addition on two qubit registers. As an example, a ripple-carry adder circuit that performs addition on two 3-qubit sized registers with a carry-in bit (`kind="full"`) is as follows: @@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -454,7 +454,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -464,7 +464,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -500,19 +500,19 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -731,7 +731,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### data - + Return the circuit data (instructions and context). **Returns** @@ -944,7 +944,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -962,7 +962,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -998,7 +998,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### global\_phase - + Return the global phase of the circuit in radians. @@ -1413,7 +1413,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1427,13 +1427,13 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1465,19 +1465,19 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits, i.e. the number of bits in each input register. **Return type** @@ -1513,7 +1513,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1661,7 +1661,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.mdx index 25fad8621e2..8946efd3ba4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # qiskit.circuit.library.CHGate - + Controlled-Hadamard gate. Applies a Hadamard on the target qubit if the control is in the $|1\rangle$ state. @@ -219,7 +219,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -229,13 +229,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -245,7 +245,7 @@ $$ ### duration - + Get the duration. @@ -263,7 +263,7 @@ $$ ### label - + Return instruction label **Return type** @@ -289,7 +289,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -303,7 +303,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -317,7 +317,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -441,7 +441,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.mdx index a3f38dfe179..82c93133b26 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # qiskit.circuit.library.CPhaseGate - + Controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -195,7 +195,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -205,13 +205,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -221,7 +221,7 @@ $$ ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return instruction label **Return type** @@ -265,7 +265,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -279,7 +279,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -293,7 +293,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -417,7 +417,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.mdx index f78f18c1719..dec0748628d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # qiskit.circuit.library.CRXGate - + Controlled-RX gate. **Circuit symbol:** @@ -216,7 +216,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -226,13 +226,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -242,7 +242,7 @@ $$ ### duration - + Get the duration. @@ -260,7 +260,7 @@ $$ ### label - + Return instruction label **Return type** @@ -286,7 +286,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -300,7 +300,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -314,7 +314,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -438,7 +438,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.mdx index 6bcdd3f5da3..ba9b85b385f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # qiskit.circuit.library.CRYGate - + Controlled-RY gate. **Circuit symbol:** @@ -216,7 +216,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -226,13 +226,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -242,7 +242,7 @@ $$ ### duration - + Get the duration. @@ -260,7 +260,7 @@ $$ ### label - + Return instruction label **Return type** @@ -286,7 +286,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -300,7 +300,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -314,7 +314,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -438,7 +438,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.mdx index bf052d10a85..6548b85e930 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # qiskit.circuit.library.CRZGate - + Controlled-RZ gate. This is a diagonal but non-symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -222,7 +222,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -232,13 +232,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -248,7 +248,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return instruction label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.mdx index 7cbafa68f92..30bed4d305e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # qiskit.circuit.library.CSXGate - + Controlled-√X gate. **Circuit symbol:** @@ -216,7 +216,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -226,13 +226,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -242,7 +242,7 @@ $$ ### duration - + Get the duration. @@ -264,7 +264,7 @@ $$ ### label - + Return instruction label **Return type** @@ -290,7 +290,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -304,7 +304,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -318,7 +318,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -442,7 +442,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.mdx index adb105b6f86..1810548e39c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # qiskit.circuit.library.CSwapGate - + Controlled-SWAP gate, also known as the Fredkin gate. **Circuit symbol:** @@ -235,7 +235,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -245,13 +245,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -261,7 +261,7 @@ $$ ### duration - + Get the duration. @@ -279,7 +279,7 @@ $$ ### label - + Return instruction label **Return type** @@ -305,7 +305,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -319,7 +319,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -333,7 +333,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -457,7 +457,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.mdx index 026e2d9a299..218bd0b4239 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # qiskit.circuit.library.CU1Gate - + Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. @@ -195,7 +195,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -205,13 +205,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -221,7 +221,7 @@ $$ ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return instruction label **Return type** @@ -265,7 +265,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -279,7 +279,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -293,7 +293,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -417,7 +417,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.mdx index 6bd6e465ae4..9876103885f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # qiskit.circuit.library.CU3Gate - + Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return instruction label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.mdx index 0925f893175..8de5560f4f8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # qiskit.circuit.library.CUGate - + Controlled-U gate (4-parameter two-qubit gate). This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $e^{i\gamma}$ of the U gate. @@ -220,7 +220,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -230,13 +230,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -246,7 +246,7 @@ $$ ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return instruction label **Return type** @@ -292,7 +292,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -306,7 +306,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -320,7 +320,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -444,7 +444,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.mdx index 912d964f8cb..00f06f51b42 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # qiskit.circuit.library.CXGate - + Controlled-X gate. **Circuit symbol:** @@ -218,7 +218,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -228,13 +228,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -244,7 +244,7 @@ $$ ### duration - + Get the duration. @@ -262,7 +262,7 @@ $$ ### label - + Return instruction label **Return type** @@ -288,7 +288,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -302,7 +302,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -316,7 +316,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -440,7 +440,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.mdx index 2164ec1b6ec..200d9b28bae 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # qiskit.circuit.library.CYGate - + Controlled-Y gate. **Circuit symbol:** @@ -216,7 +216,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -226,13 +226,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -242,7 +242,7 @@ $$ ### duration - + Get the duration. @@ -260,7 +260,7 @@ $$ ### label - + Return instruction label **Return type** @@ -286,7 +286,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -300,7 +300,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -314,7 +314,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -438,7 +438,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.mdx index 8913ba25296..88a28f5985c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # qiskit.circuit.library.CZGate - + Controlled-Z gate. This is a Clifford and symmetric gate. @@ -197,7 +197,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -207,13 +207,13 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -223,7 +223,7 @@ $$ ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return instruction label **Return type** @@ -267,7 +267,7 @@ $$ ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -281,7 +281,7 @@ $$ ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -295,7 +295,7 @@ $$ ### params - + Get parameters from base\_gate. **Returns** @@ -419,7 +419,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.mdx index 52a5a9a1f99..9117e9c4abe 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # qiskit.circuit.library.DCXGate - + Double-CNOT gate. A 2-qubit Clifford gate consisting of two back-to-back CNOTs with alternate controls. @@ -191,19 +191,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return instruction label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -375,7 +375,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.mdx index 1108aa83cb0..bd94d521604 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # qiskit.circuit.library.Diagonal - + Diagonal circuit. Circuit symbol: @@ -273,7 +273,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -435,7 +435,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -445,7 +445,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -481,19 +481,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -712,7 +712,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -943,7 +943,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -979,7 +979,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1394,7 +1394,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1408,13 +1408,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1446,13 +1446,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1480,7 +1480,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1628,7 +1628,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.mdx index 32189ee0004..9456c88ec6b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # qiskit.circuit.library.DraperQFTAdder - + A circuit that uses QFT to perform in-place addition on two qubit registers. For registers with $n$ qubits, the QFT adder can perform addition modulo $2^n$ (with `kind="fixed"`) or ordinary addition by adding a carry qubits (with `kind="half"`). @@ -263,7 +263,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -471,19 +471,19 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -702,7 +702,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### data - + Return the circuit data (instructions and context). **Returns** @@ -915,7 +915,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -933,7 +933,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -969,7 +969,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### global\_phase - + Return the global phase of the circuit in radians. @@ -1384,7 +1384,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1398,13 +1398,13 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1436,19 +1436,19 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits, i.e. the number of bits in each input register. **Return type** @@ -1484,7 +1484,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1632,7 +1632,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.mdx index 730378bb211..f4cf5c4d338 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # qiskit.circuit.library.ECRGate - + An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). This gate is maximally entangling and is equivalent to a CNOT up to single-qubit pre-rotations. The echoing procedure mitigates some unwanted terms (terms other than ZX) to cancel in an experiment. @@ -215,19 +215,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -261,7 +261,7 @@ $$ ### label - + Return instruction label **Return type** @@ -287,7 +287,7 @@ $$ ### params - + return instruction params. @@ -387,7 +387,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.mdx index e63c83aeceb..32e62546682 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # qiskit.circuit.library.EfficientSU2 - + The hardware efficient SU(2) 2-local circuit. The `EfficientSU2` circuit consists of layers of single qubit operations spanned by SU(2) and $CX$ entanglements. This is a heuristic pattern that can be used to prepare trial wave functions for variational quantum algorithms or classification circuit for machine learning. @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -426,7 +426,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -462,19 +462,19 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + Return the circuit data (instructions and context). **Returns** @@ -874,7 +874,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -952,7 +952,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1012,7 +1012,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### global\_phase - + Return the global phase of the circuit in radians. @@ -1060,7 +1060,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1190,7 +1190,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1455,7 +1455,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1469,13 +1469,13 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1551,7 +1551,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1581,7 +1581,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1617,7 +1617,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1672,7 +1672,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1743,7 +1743,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qregs - + A list of the quantum registers associated with the circuit. @@ -1817,7 +1817,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1879,7 +1879,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1985,7 +1985,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index c4738f50db9..c20509a85e4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # qiskit.circuit.library.EvolvedOperatorAnsatz - + The evolved operator ansatz. **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -403,7 +403,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -413,7 +413,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -449,19 +449,19 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -680,7 +680,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### data - + Return the circuit data (instructions and context). **Returns** @@ -861,7 +861,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### evolution - + The evolution converter used to compute the evolution. **Returns** @@ -907,7 +907,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### global\_phase - + Return the global phase of the circuit in radians. @@ -1009,7 +1009,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### initial\_state - + The initial state. **Return type** @@ -1386,7 +1386,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1400,13 +1400,13 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1438,7 +1438,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1448,7 +1448,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### num\_qubits - + Return number of qubits. @@ -1470,7 +1470,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### operators - + The operators that are evolved in this circuit. **Returns** @@ -1490,7 +1490,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -1580,7 +1580,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### qregs - + A list of the quantum registers associated with the circuit. @@ -1654,7 +1654,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1716,7 +1716,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### reps - + The number of times the evolved operators are repeated. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.mdx index 8128c952a4d..1eb7a17a488 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # qiskit.circuit.library.ExcitationPreserving - + The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. The matrix representing the operation is @@ -356,7 +356,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -439,7 +439,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -449,7 +449,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -485,19 +485,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -716,7 +716,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -897,7 +897,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -911,7 +911,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -957,7 +957,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1035,7 +1035,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1083,7 +1083,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1213,7 +1213,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1478,7 +1478,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1492,13 +1492,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1522,7 +1522,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1544,7 +1544,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1554,7 +1554,7 @@ $$ ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1574,7 +1574,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1604,7 +1604,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1640,7 +1640,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1654,7 +1654,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1695,7 +1695,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1766,7 +1766,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1840,7 +1840,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1902,7 +1902,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2008,7 +2008,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.mdx index 9c987514cc8..42eca94d66b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # qiskit.circuit.library.FourierChecking - + Fourier checking circuit. The circuit for the Fourier checking algorithm, introduced in \[1], involves a layer of Hadamards, the function $f$, another layer of Hadamards, the function $g$, followed by a final layer of Hadamards. The functions $f$ and $g$ are classical functions realized as phase oracles (diagonal operators with \{-1, 1} on the diagonal). @@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -423,7 +423,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -433,7 +433,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -469,19 +469,19 @@ python_api_name: qiskit.circuit.library.FourierChecking ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -700,7 +700,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### data - + Return the circuit data (instructions and context). **Returns** @@ -913,7 +913,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -931,7 +931,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -967,7 +967,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### global\_phase - + Return the global phase of the circuit in radians. @@ -1382,7 +1382,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1396,13 +1396,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1434,13 +1434,13 @@ python_api_name: qiskit.circuit.library.FourierChecking ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1468,7 +1468,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1616,7 +1616,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.mdx index 95a1bf17797..81fa39220a5 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # qiskit.circuit.library.FunctionalPauliRotations - + Base class for functional Pauli rotations. Create a new functional Pauli rotation circuit. @@ -237,7 +237,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -373,7 +373,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -692,7 +692,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + Return the circuit data (instructions and context). **Returns** @@ -905,7 +905,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -923,7 +923,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -959,7 +959,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### global\_phase - + Return the global phase of the circuit in radians. @@ -1374,7 +1374,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1388,7 +1388,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1402,13 +1402,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1440,7 +1440,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1450,13 +1450,13 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1492,7 +1492,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1576,7 +1576,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qregs - + A list of the quantum registers associated with the circuit. @@ -1650,7 +1650,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.mdx index d019beee28c..3e964c8833b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # qiskit.circuit.library.GMS - + Global Mølmer–Sørensen gate. **Circuit symbol:** @@ -262,7 +262,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -424,7 +424,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -434,7 +434,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -470,19 +470,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -701,7 +701,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -914,7 +914,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -932,7 +932,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -968,7 +968,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1383,7 +1383,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1397,13 +1397,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1435,13 +1435,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1469,7 +1469,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1617,7 +1617,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GR.mdx index d4c74b58e51..04a871f0c00 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # qiskit.circuit.library.GR - + Global R gate. **Circuit symbol:** @@ -257,7 +257,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -419,7 +419,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -429,7 +429,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -465,19 +465,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -696,7 +696,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -909,7 +909,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -927,7 +927,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -963,7 +963,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1378,7 +1378,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1392,13 +1392,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1430,13 +1430,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1464,7 +1464,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1612,7 +1612,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.mdx index 1441f98e096..a8af4099da0 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # qiskit.circuit.library.GRX - + Global RX gate. **Circuit symbol:** @@ -255,7 +255,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,13 +1390,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1428,13 +1428,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1462,7 +1462,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1610,7 +1610,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.mdx index 78d38de7f75..465a2442b8e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # qiskit.circuit.library.GRY - + Global RY gate. **Circuit symbol:** @@ -255,7 +255,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,13 +1390,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1428,13 +1428,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1462,7 +1462,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1610,7 +1610,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.mdx index ffce36a47b4..0c3fefd2c38 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # qiskit.circuit.library.GRZ - + Global RZ gate. **Circuit symbol:** @@ -255,7 +255,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,13 +1390,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1428,13 +1428,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1462,7 +1462,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1610,7 +1610,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.mdx index e1e2381081f..aead99bcd6b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # qiskit.circuit.library.GraphState - + Circuit to prepare a graph state. Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as @@ -265,7 +265,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -427,7 +427,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -437,7 +437,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -473,19 +473,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -704,7 +704,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -917,7 +917,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -971,7 +971,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1386,7 +1386,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1400,13 +1400,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1438,13 +1438,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1472,7 +1472,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1620,7 +1620,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.mdx index e7369f8dc8f..6e26e346f9f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # qiskit.circuit.library.GroverOperator - + The Grover operator. Grover’s search algorithm \[1, 2] consists of repeated applications of the so-called Grover operator used to amplify the amplitudes of the desired output states. This operator, $\mathcal{Q}$, consists of the phase oracle, $\mathcal{S}_f$, zero phase-shift or zero reflection, $\mathcal{S}_0$, and an input state preparation $\mathcal{A}$: @@ -370,7 +370,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -532,7 +532,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -542,7 +542,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -578,19 +578,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -809,7 +809,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1022,7 +1022,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1040,7 +1040,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1076,7 +1076,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1491,7 +1491,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1505,13 +1505,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1543,13 +1543,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1571,7 +1571,7 @@ $$ ### oracle - + The oracle implementing a reflection about the bad state. @@ -1583,7 +1583,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1731,7 +1731,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1755,7 +1755,7 @@ $$ ### reflection\_qubits - + Reflection qubits, on which S0 is applied (if S0 is not user-specified). @@ -2627,7 +2627,7 @@ $$ ### state\_preparation - + The subcircuit implementing the A operator or Hadamards. **Return type** @@ -2929,7 +2929,7 @@ $$ ### zero\_reflection - + The subcircuit implementing the reflection about 0. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.mdx index d42a83044d2..87ce98e15dd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # qiskit.circuit.library.HGate - + Single-qubit Hadamard gate. This gate is a pi rotation about the X+Z axis, and has the effect of changing computation basis from $|0\rangle,|1\rangle$ to $|+\rangle,|-\rangle$ and vice-versa. @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -217,7 +217,7 @@ $$ ### label - + Return instruction label **Return type** @@ -243,7 +243,7 @@ $$ ### params - + return instruction params. @@ -355,7 +355,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index d7febd47c46..1d2e02c6387 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # qiskit.circuit.library.HRSCumulativeMultiplier - + A multiplication circuit to store product of two input registers out-of-place. Circuit uses the approach from \[1]. As an example, a multiplier circuit that performs a non-modular multiplication on two 3-qubit sized registers with the default adder is as follows (where `Adder` denotes the `CDKMRippleCarryAdder`): @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -440,7 +440,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -450,7 +450,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -486,19 +486,19 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -717,7 +717,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### data - + Return the circuit data (instructions and context). **Returns** @@ -930,7 +930,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -948,7 +948,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -984,7 +984,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### global\_phase - + Return the global phase of the circuit in radians. @@ -1399,7 +1399,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1413,13 +1413,13 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1451,19 +1451,19 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_result\_qubits - + The number of result qubits to limit the output to. **Return type** @@ -1477,7 +1477,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### num\_state\_qubits - + The number of state qubits, i.e. the number of bits in each input register. **Return type** @@ -1513,7 +1513,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1661,7 +1661,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.mdx index 2b5cce0c142..65de19a986e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # qiskit.circuit.library.HiddenLinearFunction - + Circuit to solve the hidden linear function problem. The 2D Hidden Linear Function problem is determined by a 2D adjacency matrix A, where only elements that are nearest-neighbor on a grid have non-zero entries. Each row/column corresponds to one binary variable $x_i$. @@ -265,7 +265,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -427,7 +427,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -437,7 +437,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -473,19 +473,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -704,7 +704,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -917,7 +917,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -935,7 +935,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -971,7 +971,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1386,7 +1386,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1400,13 +1400,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1438,13 +1438,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1472,7 +1472,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1620,7 +1620,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.mdx index 594de32ca9f..c7c41e2f2ed 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # qiskit.circuit.library.IGate - + Identity gate. Identity gate corresponds to a single-qubit gate wait cycle, and should not be optimized or unrolled (it is an opaque gate). @@ -188,19 +188,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -218,7 +218,7 @@ $$ ### label - + Return instruction label **Return type** @@ -244,7 +244,7 @@ $$ ### params - + return instruction params. @@ -356,7 +356,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.mdx index 44c26858817..5d3ccdb0e26 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # qiskit.circuit.library.IQP - + Instantaneous quantum polynomial (IQP) circuit. The circuit consists of a column of Hadamard gates, a column of powers of T gates, a sequence of powers of CS gates (up to $\frac{n^2-n}{2}$ of them), and a final column of Hadamard gates, as introduced in \[1]. @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.library.IQP ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.library.IQP ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.IQP ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -461,19 +461,19 @@ python_api_name: qiskit.circuit.library.IQP ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -692,7 +692,7 @@ python_api_name: qiskit.circuit.library.IQP ### data - + Return the circuit data (instructions and context). **Returns** @@ -905,7 +905,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -923,7 +923,7 @@ python_api_name: qiskit.circuit.library.IQP ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -959,7 +959,7 @@ python_api_name: qiskit.circuit.library.IQP ### global\_phase - + Return the global phase of the circuit in radians. @@ -1374,7 +1374,7 @@ python_api_name: qiskit.circuit.library.IQP ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1388,13 +1388,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1426,13 +1426,13 @@ python_api_name: qiskit.circuit.library.IQP ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1460,7 +1460,7 @@ python_api_name: qiskit.circuit.library.IQP ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1608,7 +1608,7 @@ python_api_name: qiskit.circuit.library.IQP ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.mdx index 0d66cea662f..90e8603f41a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # qiskit.circuit.library.InnerProduct - + A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. This implementation is a phase oracle which computes the following transform. @@ -260,7 +260,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -422,7 +422,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -432,7 +432,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -468,19 +468,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -699,7 +699,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -912,7 +912,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -930,7 +930,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -966,7 +966,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1381,7 +1381,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1395,13 +1395,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1433,13 +1433,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1467,7 +1467,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1615,7 +1615,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.mdx index 6bcd625d54c..4fda2795d0b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # qiskit.circuit.library.IntegerComparator - + Integer Comparator. Operator compares basis states $|i\rangle_n$ against a classically given integer $L$ of fixed value and flips a target qubit if $i \geq L$ (or $<$ depending on the parameter `geq`): @@ -248,7 +248,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -410,7 +410,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -420,7 +420,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -456,19 +456,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -936,7 +936,7 @@ $$ ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -968,7 +968,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1383,7 +1383,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1397,19 +1397,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1441,7 +1441,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1451,13 +1451,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -1493,7 +1493,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1577,7 +1577,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1651,7 +1651,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2801,7 +2801,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.mdx index d1e7e228a1d..34c84eaea4c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # qiskit.circuit.library.LinearAmplitudeFunction - + A circuit implementing a (piecewise) linear function on qubit amplitudes. An amplitude function $F$ of a function $f$ is a mapping @@ -281,7 +281,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -443,7 +443,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -453,7 +453,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -489,19 +489,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -720,7 +720,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -933,7 +933,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -951,7 +951,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -987,7 +987,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1402,7 +1402,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1416,13 +1416,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1454,13 +1454,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1488,7 +1488,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1654,7 +1654,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.mdx index 30f64829d8d..2a7bde1760c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # qiskit.circuit.library.LinearPauliRotations - + Linearly-controlled X, Y or Z rotation. For a register of state qubits $|x\rangle$, a target qubit $|0\rangle$ and the basis `'Y'` this circuit acts as: @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -400,7 +400,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -442,7 +442,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -719,7 +719,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -932,7 +932,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -950,7 +950,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -986,7 +986,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1401,7 +1401,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1415,7 +1415,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1429,13 +1429,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1467,7 +1467,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1477,13 +1477,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1513,7 +1513,7 @@ $$ ### offset - + The angle of the single qubit offset rotation on the target qubit. Before applying the controlled rotations, a single rotation of angle `offset` is applied to the target qubit. @@ -1535,7 +1535,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1619,7 +1619,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1693,7 +1693,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2392,7 +2392,7 @@ $$ ### slope - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.mdx index cecc157bf00..72e99aa6dab 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # qiskit.circuit.library.LogNormalDistribution - + A circuit to encode a discretized log-normal distribution in qubit amplitudes. A random variable $X$ is log-normal distributed if @@ -282,7 +282,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -444,7 +444,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -454,7 +454,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -464,7 +464,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -500,19 +500,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -731,7 +731,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -944,7 +944,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -962,7 +962,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -998,7 +998,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1413,7 +1413,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1427,13 +1427,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1465,13 +1465,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1499,7 +1499,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1536,7 +1536,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1657,7 +1657,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2807,7 +2807,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.mdx index da12916340b..eb4df35acfc 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # qiskit.circuit.library.MCMT - + The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as: @@ -263,7 +263,7 @@ python_api_name: qiskit.circuit.library.MCMT ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -425,7 +425,7 @@ python_api_name: qiskit.circuit.library.MCMT ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.library.MCMT ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -471,19 +471,19 @@ python_api_name: qiskit.circuit.library.MCMT ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -684,7 +684,7 @@ python_api_name: qiskit.circuit.library.MCMT ### data - + Return the circuit data (instructions and context). **Returns** @@ -897,7 +897,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -915,7 +915,7 @@ python_api_name: qiskit.circuit.library.MCMT ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -951,7 +951,7 @@ python_api_name: qiskit.circuit.library.MCMT ### global\_phase - + Return the global phase of the circuit in radians. @@ -1326,7 +1326,7 @@ python_api_name: qiskit.circuit.library.MCMT ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1340,19 +1340,19 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_ancilla\_qubits - + Return the number of ancillas. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1384,13 +1384,13 @@ python_api_name: qiskit.circuit.library.MCMT ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1418,7 +1418,7 @@ python_api_name: qiskit.circuit.library.MCMT ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1566,7 +1566,7 @@ python_api_name: qiskit.circuit.library.MCMT ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.mdx index 4a223eba260..1dc5c9480c4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # qiskit.circuit.library.MCMTVChain - + The MCMT implementation using the CCX V-chain. This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). @@ -287,7 +287,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -449,7 +449,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -459,7 +459,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -495,19 +495,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -708,7 +708,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### data - + Return the circuit data (instructions and context). **Returns** @@ -921,7 +921,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -939,7 +939,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### global\_phase - + Return the global phase of the circuit in radians. @@ -1350,7 +1350,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1364,19 +1364,19 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_ancilla\_qubits - + Return the number of ancilla qubits required. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1408,13 +1408,13 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1442,7 +1442,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1590,7 +1590,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.mdx index 4e9002a3294..7280956e266 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # qiskit.circuit.library.MCPhaseGate - + Multi-controlled-Phase gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the state of the control qubits. @@ -187,7 +187,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -197,13 +197,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### duration - + Get the duration. @@ -231,7 +231,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### label - + Return instruction label **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -271,7 +271,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -285,7 +285,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### params - + Get parameters from base\_gate. **Returns** @@ -409,7 +409,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.mdx index 82af89b17eb..94a24e3589f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # qiskit.circuit.library.MCXGate - + The general, multi-controlled X gate. Create new MCX gate. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -180,13 +180,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -196,13 +196,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -262,13 +262,13 @@ python_api_name: qiskit.circuit.library.MCXGate ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -282,7 +282,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### params - + Get parameters from base\_gate. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.mdx index bacbc9d0312..2997287ccce 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # qiskit.circuit.library.MCXGrayCode - + Implement the multi-controlled X gate using the Gray code. This delegates the implementation to the MCU1 gate, since $X = H \cdot U1(\pi) \cdot H$. @@ -172,7 +172,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -182,13 +182,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -198,13 +198,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### label - + Return instruction label **Return type** @@ -250,7 +250,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -264,13 +264,13 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### params - + Get parameters from base\_gate. **Returns** @@ -408,7 +408,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.mdx index 9f429fabee2..0024de5fee7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # qiskit.circuit.library.MCXRecursive - + Implement the multi-controlled X gate using recursion. Using a single ancilla qubit, the multi-controlled X gate is recursively split onto four sub-registers. This is done until we reach the 3- or 4-controlled X gate since for these we have a concrete implementation that do not require ancillas. @@ -172,7 +172,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -182,13 +182,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -198,13 +198,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -262,13 +262,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -282,7 +282,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### params - + Get parameters from base\_gate. **Returns** @@ -406,7 +406,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.mdx index 98296341598..cfd0bed8107 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # qiskit.circuit.library.MCXVChain - + Implement the multi-controlled X gate using a V-chain of CX gates. Create new MCX gate. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -180,13 +180,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition. **Return type** @@ -196,13 +196,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### duration - + Get the duration. ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### label - + Return instruction label **Return type** @@ -246,7 +246,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### name - + Get name of gate. If the gate has open controls the gate name will become: > \ @@ -260,13 +260,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### num\_ancilla\_qubits - + The number of ancilla qubits. ### num\_ctrl\_qubits - + Get number of control qubits. **Returns** @@ -280,7 +280,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### params - + Get parameters from base\_gate. **Returns** @@ -404,7 +404,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.mdx index 102d0e4a076..1a7091646f3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # qiskit.circuit.library.MSGate - + MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. Global Mølmer–Sørensen gate. @@ -175,19 +175,19 @@ python_api_name: qiskit.circuit.library.MSGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -221,7 +221,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return instruction label **Return type** @@ -247,7 +247,7 @@ python_api_name: qiskit.circuit.library.MSGate ### params - + return instruction params. @@ -359,7 +359,7 @@ python_api_name: qiskit.circuit.library.MSGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.mdx index ae39baf0958..49768c73f45 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # qiskit.circuit.library.Measure - + Quantum measurement in the computational basis. Create new measurement instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Measure ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.library.Measure ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.Measure ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.Measure ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.mdx index 4caaf48e4de..564cab01e83 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # qiskit.circuit.library.NLocal - + The n-local circuit class. The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended. @@ -337,7 +337,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -420,7 +420,7 @@ python_api_name: qiskit.circuit.library.NLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -430,7 +430,7 @@ python_api_name: qiskit.circuit.library.NLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -466,19 +466,19 @@ python_api_name: qiskit.circuit.library.NLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -697,7 +697,7 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -878,7 +878,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -938,7 +938,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.NLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1036,7 +1036,7 @@ python_api_name: qiskit.circuit.library.NLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1084,7 +1084,7 @@ python_api_name: qiskit.circuit.library.NLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1214,7 +1214,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1479,7 +1479,7 @@ python_api_name: qiskit.circuit.library.NLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1493,13 +1493,13 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1523,7 +1523,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1545,7 +1545,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1555,7 +1555,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1575,7 +1575,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1641,7 +1641,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1655,7 +1655,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1696,7 +1696,7 @@ python_api_name: qiskit.circuit.library.NLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1767,7 +1767,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1841,7 +1841,7 @@ python_api_name: qiskit.circuit.library.NLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1903,7 +1903,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2009,7 +2009,7 @@ python_api_name: qiskit.circuit.library.NLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.mdx index 964ee444d34..79680c975e7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # qiskit.circuit.library.NormalDistribution - + A circuit to encode a discretized normal distribution in qubit amplitudes. The probability density function of the normal distribution is defined as @@ -330,7 +330,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -492,7 +492,7 @@ $$ ### bounds - + Return the bounds of the probability distribution. **Return type** @@ -502,7 +502,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -512,7 +512,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -548,19 +548,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -779,7 +779,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -992,7 +992,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1010,7 +1010,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1046,7 +1046,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1461,7 +1461,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1475,13 +1475,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1513,13 +1513,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1547,7 +1547,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1584,7 +1584,7 @@ $$ ### probabilities - + Return the sampling probabilities for the values. **Return type** @@ -1705,7 +1705,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2855,7 +2855,7 @@ $$ ### values - + Return the discretized points of the random variable. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.OR.mdx index 6302989e6f5..dff725ed355 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # qiskit.circuit.library.OR - + A circuit implementing the logical OR operation on a number of qubits. For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated. @@ -243,7 +243,7 @@ python_api_name: qiskit.circuit.library.OR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -402,7 +402,7 @@ python_api_name: qiskit.circuit.library.OR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.OR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -448,19 +448,19 @@ python_api_name: qiskit.circuit.library.OR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -679,7 +679,7 @@ python_api_name: qiskit.circuit.library.OR ### data - + Return the circuit data (instructions and context). **Returns** @@ -892,7 +892,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -910,7 +910,7 @@ python_api_name: qiskit.circuit.library.OR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.OR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1361,7 +1361,7 @@ python_api_name: qiskit.circuit.library.OR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1375,13 +1375,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1413,13 +1413,13 @@ python_api_name: qiskit.circuit.library.OR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1447,7 +1447,7 @@ python_api_name: qiskit.circuit.library.OR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1595,7 +1595,7 @@ python_api_name: qiskit.circuit.library.OR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.mdx index bf05b72ced0..bc825eaae45 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # qiskit.circuit.library.PauliFeatureMap - + The Pauli Expansion circuit. The Pauli Expansion circuit is a data encoding circuit that transforms input data $\vec{x} \in \mathbb{R}^n$ as @@ -365,7 +365,7 @@ $$ ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -379,7 +379,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -462,7 +462,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -472,7 +472,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -508,19 +508,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -739,7 +739,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -920,7 +920,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -934,7 +934,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -970,7 +970,7 @@ $$ ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -990,7 +990,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1008,7 +1008,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1088,7 +1088,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1136,7 +1136,7 @@ $$ ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1266,7 +1266,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1531,7 +1531,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1545,13 +1545,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1575,7 +1575,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1597,7 +1597,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1607,13 +1607,13 @@ $$ ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1643,7 +1643,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1679,7 +1679,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1693,7 +1693,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1721,7 +1721,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1760,7 +1760,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1831,7 +1831,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1905,7 +1905,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1967,7 +1967,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2073,7 +2073,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.mdx index c26599b0846..49da700c08f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # qiskit.circuit.library.PauliGate - + A multi-qubit Pauli gate. This gate exists for optimization purposes for the quantum statevector simulation, since applying multiple pauli gates to different qubits at once can be done via a single pass on the statevector. @@ -187,19 +187,19 @@ python_api_name: qiskit.circuit.library.PauliGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.library.PauliGate ### label - + Return instruction label **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.circuit.library.PauliGate ### params - + return instruction params. @@ -355,7 +355,7 @@ python_api_name: qiskit.circuit.library.PauliGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.mdx index aaff4de1f70..6a8b6ab1c1d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # qiskit.circuit.library.PauliTwoDesign - + The Pauli Two-Design ansatz. This class implements a particular form of a 2-design circuit \[1], which is frequently studied in quantum machine learning literature, such as e.g. the investigating of Barren plateaus in variational algorithms \[2]. @@ -315,7 +315,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -398,7 +398,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -408,7 +408,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -444,19 +444,19 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -675,7 +675,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### data - + Return the circuit data (instructions and context). **Returns** @@ -856,7 +856,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement - + Get the entanglement strategy. **Return type** @@ -870,7 +870,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -916,7 +916,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -994,7 +994,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### global\_phase - + Return the global phase of the circuit in radians. @@ -1042,7 +1042,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1172,7 +1172,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1437,7 +1437,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1451,13 +1451,13 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1503,7 +1503,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1513,7 +1513,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters\_settable - + Return the number of settable parameters. **Return type** @@ -1527,7 +1527,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1557,7 +1557,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1593,7 +1593,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1607,7 +1607,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1648,7 +1648,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1719,7 +1719,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qregs - + A list of the quantum registers associated with the circuit. @@ -1793,7 +1793,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1855,7 +1855,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -1961,7 +1961,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.mdx index bd0b5ec3ae6..de31e9d17c7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # qiskit.circuit.library.Permutation - + An n\_qubit circuit that permutes qubits. Return an n\_qubit permutation circuit implemented using SWAPs. @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.Permutation ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -416,7 +416,7 @@ python_api_name: qiskit.circuit.library.Permutation ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -426,7 +426,7 @@ python_api_name: qiskit.circuit.library.Permutation ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -462,19 +462,19 @@ python_api_name: qiskit.circuit.library.Permutation ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -693,7 +693,7 @@ python_api_name: qiskit.circuit.library.Permutation ### data - + Return the circuit data (instructions and context). **Returns** @@ -906,7 +906,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -924,7 +924,7 @@ python_api_name: qiskit.circuit.library.Permutation ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -960,7 +960,7 @@ python_api_name: qiskit.circuit.library.Permutation ### global\_phase - + Return the global phase of the circuit in radians. @@ -1375,7 +1375,7 @@ python_api_name: qiskit.circuit.library.Permutation ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1389,13 +1389,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1427,13 +1427,13 @@ python_api_name: qiskit.circuit.library.Permutation ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1461,7 +1461,7 @@ python_api_name: qiskit.circuit.library.Permutation ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1609,7 +1609,7 @@ python_api_name: qiskit.circuit.library.Permutation ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.mdx index 22650cbf7d8..55033ea9080 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # qiskit.circuit.library.PhaseEstimation - + Phase Estimation circuit. In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is @@ -269,7 +269,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -431,7 +431,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -441,7 +441,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -477,19 +477,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -708,7 +708,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -921,7 +921,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -939,7 +939,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -975,7 +975,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1390,7 +1390,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1404,13 +1404,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1442,13 +1442,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1476,7 +1476,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1624,7 +1624,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.mdx index f75ff8e0bfc..28ae5f5d226 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # qiskit.circuit.library.PhaseGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -209,19 +209,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -239,7 +239,7 @@ $$ ### label - + Return instruction label **Return type** @@ -265,7 +265,7 @@ $$ ### params - + return instruction params. @@ -377,7 +377,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.mdx index 310b82fcfad..7a065bbfc98 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # qiskit.circuit.library.PhaseOracle - + Phase Oracle. The Phase Oracle object constructs circuits for any arbitrary input logical expressions. A logical expression is composed of logical operators & (AND), | (OR), \~ (NOT), and ^ (XOR). as well as symbols for literals (variables). For example, ‘a & b’, and (v0 | \~v1) & (\~v2 & v3) are both valid string representation of boolean logical expressions. @@ -239,7 +239,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -401,7 +401,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -411,7 +411,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -447,19 +447,19 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -678,7 +678,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### data - + Return the circuit data (instructions and context). **Returns** @@ -909,7 +909,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. @@ -945,7 +945,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -963,7 +963,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -999,7 +999,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### global\_phase - + Return the global phase of the circuit in radians. @@ -1414,7 +1414,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1428,13 +1428,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1466,13 +1466,13 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1500,7 +1500,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1648,7 +1648,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.mdx index 48a504b9845..0546b375083 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # qiskit.circuit.library.PiecewiseChebyshev - + Piecewise Chebyshev approximation to an input function. For a given function $f(x)$ and degree $d$, this class implements a piecewise polynomial Chebyshev approximation on $n$ qubits to $f(x)$ on the given intervals. All the polynomials in the approximation are of degree $d$. @@ -266,7 +266,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -428,7 +428,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### breakpoints - + The breakpoints for the piecewise approximation. **Return type** @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -719,7 +719,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### data - + Return the circuit data (instructions and context). **Returns** @@ -755,7 +755,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### degree - + The degree of the polynomials. **Return type** @@ -940,7 +940,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### f\_x - + The function to be approximated. **Return type** @@ -960,7 +960,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -978,7 +978,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### global\_phase - + Return the global phase of the circuit in radians. @@ -1429,7 +1429,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1443,13 +1443,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1481,7 +1481,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1491,13 +1491,13 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1533,7 +1533,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1549,7 +1549,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### polynomials - + The polynomials for the piecewise approximation. **Return type** @@ -1631,7 +1631,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qregs - + A list of the quantum registers associated with the circuit. @@ -1705,7 +1705,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 2200b270598..475cd284a71 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # qiskit.circuit.library.PiecewiseLinearPauliRotations - + Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: @@ -261,7 +261,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -397,7 +397,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -439,7 +439,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -451,7 +451,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -461,7 +461,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -497,19 +497,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -600,7 +600,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -742,7 +742,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -973,7 +973,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -991,7 +991,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1027,7 +1027,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1297,7 +1297,7 @@ $$ ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -1311,7 +1311,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -1470,7 +1470,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1484,19 +1484,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1528,7 +1528,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1538,13 +1538,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1574,7 +1574,7 @@ $$ ### offsets - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -1592,7 +1592,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1676,7 +1676,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1750,7 +1750,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2449,7 +2449,7 @@ $$ ### slopes - + The breakpoints of the piecewise linear function. The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index e257c04f91e..e1268722a7e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # qiskit.circuit.library.PiecewisePolynomialPauliRotations - + Piecewise-polynomially-controlled Pauli rotations. This class implements a piecewise polynomial (not necessarily continuous) function, $f(x)$, on qubit amplitudes, which is defined through breakpoints and coefficients as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding coefficients by $[a_{j,1},...,a_{j,d}]$, where $d$ is the highest degree among all polynomials. @@ -302,7 +302,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -438,7 +438,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -480,7 +480,7 @@ $$ ### breakpoints - + The breakpoints of the piecewise polynomial function. The function is polynomial in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. @@ -496,7 +496,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -506,7 +506,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -542,19 +542,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -566,7 +566,7 @@ $$ ### coeffs - + The coefficients of the polynomials. **Return type** @@ -659,7 +659,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -801,7 +801,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -1032,7 +1032,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1050,7 +1050,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1086,7 +1086,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1356,7 +1356,7 @@ $$ ### mapped\_coeffs - + The coefficients mapped to the internal representation, since we only compare x>=breakpoint. **Return type** @@ -1515,7 +1515,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1529,7 +1529,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -1543,13 +1543,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1581,7 +1581,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1591,13 +1591,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1633,7 +1633,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1717,7 +1717,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1791,7 +1791,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.mdx index f085167fd8e..38e570b90a9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # qiskit.circuit.library.PolynomialPauliRotations - + A circuit implementing polynomial Pauli rotations. For a polynomial :math\`p(x)\`, a basis state $|i\rangle$ and a target qubit $|0\rangle$ this operator acts as: @@ -264,7 +264,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -400,7 +400,7 @@ $$ ### basis - + The kind of Pauli rotation to be used. Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotations respectively. @@ -442,7 +442,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -452,7 +452,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -488,19 +488,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -512,7 +512,7 @@ $$ ### coeffs - + The multiplicative factor in the rotation angle of the controlled rotations. The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` where `n` is the number of state qubits. @@ -735,7 +735,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -771,7 +771,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -962,7 +962,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -980,7 +980,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1016,7 +1016,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1431,7 +1431,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1445,19 +1445,19 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1489,7 +1489,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1499,13 +1499,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -1541,7 +1541,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1625,7 +1625,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1699,7 +1699,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1767,7 +1767,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.mdx index 05c55e8ec1a..ded0741ab09 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # qiskit.circuit.library.QAOAAnsatz - + A generalized QAOA quantum circuit with a support of custom initial states and mixers. **References** @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -420,7 +420,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -456,19 +456,19 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -601,7 +601,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### cost\_operator - + Returns an operator representing the cost of the optimization problem. **Returns** @@ -701,7 +701,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### data - + Return the circuit data (instructions and context). **Returns** @@ -882,7 +882,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### evolution - + The evolution converter used to compute the evolution. **Returns** @@ -928,7 +928,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -946,7 +946,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -982,7 +982,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### global\_phase - + Return the global phase of the circuit in radians. @@ -1030,7 +1030,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### initial\_state - + Returns an optional initial state as a circuit **Return type** @@ -1407,7 +1407,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### mixer\_operator - + Returns an optional mixer operator expressed as an operator or a quantum circuit. **Returns** @@ -1435,13 +1435,13 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1473,7 +1473,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1483,7 +1483,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_qubits - + Return the number of qubits, specified by the size of the cost operator. **Return type** @@ -1509,7 +1509,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### operators - + The operators that are evolved in this circuit. **Returns** @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameter\_bounds - + Parameter bounds. **Returns: A list of pairs indicating the bounds, as (lower, upper). None indicates** @@ -1545,7 +1545,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -1590,7 +1590,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### preferred\_init\_points - + Getter of preferred initial points based on the given initial state. @@ -1639,7 +1639,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qregs - + A list of the quantum registers associated with the circuit. @@ -1713,7 +1713,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1775,7 +1775,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### reps - + Returns the reps parameter, which determines the depth of the circuit. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.mdx index ab40bce969b..997b979966d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # qiskit.circuit.library.QFT - + Quantum Fourier Transform Circuit. The Quantum Fourier Transform (QFT) on $n$ qubits is the operation @@ -266,7 +266,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -297,7 +297,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -439,7 +439,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -449,7 +449,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -485,19 +485,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -716,7 +716,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -819,7 +819,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -943,7 +943,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -997,7 +997,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1161,7 +1161,7 @@ $$ ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -1408,7 +1408,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1422,13 +1422,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1460,7 +1460,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1470,7 +1470,7 @@ $$ ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -1510,7 +1510,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1594,7 +1594,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1668,7 +1668,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.mdx index 5f3cbf9b2bf..221992b56c1 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # qiskit.circuit.library.QuadraticForm - + Implements a quadratic form on binary variables encoded in qubit registers. A quadratic form on binary variables is a quadratic function $Q$ acting on a binary variable of $n$ bits, $x = x_0 ... x_{n-1}$. For an integer matrix $A$, an integer vector $b$ and an integer $c$ the function can be written as @@ -270,7 +270,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -432,7 +432,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -442,7 +442,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -478,19 +478,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -709,7 +709,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -922,7 +922,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -940,7 +940,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -976,7 +976,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1391,7 +1391,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1405,13 +1405,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1443,13 +1443,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1477,7 +1477,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1625,7 +1625,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1687,7 +1687,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.mdx index a8a97c9b784..0c773f2ebc3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # qiskit.circuit.library.QuantumVolume - + A quantum volume model circuit. The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1]. @@ -251,7 +251,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -410,7 +410,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -420,7 +420,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -456,19 +456,19 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -687,7 +687,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### data - + Return the circuit data (instructions and context). **Returns** @@ -900,7 +900,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### global\_phase - + Return the global phase of the circuit in radians. @@ -1369,7 +1369,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1383,13 +1383,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1421,13 +1421,13 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1455,7 +1455,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1603,7 +1603,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.mdx index 5d93692725a..fcd5fc017fb 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # qiskit.circuit.library.RC3XGate - + The simplified 3-controlled Toffoli gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -173,19 +173,19 @@ python_api_name: qiskit.circuit.library.RC3XGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return instruction label **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### params - + return instruction params. @@ -357,7 +357,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.mdx index dc1bf0614ad..f561921f599 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # qiskit.circuit.library.RCCXGate - + The simplified Toffoli gate, also referred to as Margolus gate. The simplified Toffoli gate implements the Toffoli gate up to relative phases. This implementation requires three CX gates which is the minimal amount possible, as shown in [https://arxiv.org/abs/quant-ph/0312225](https://arxiv.org/abs/quant-ph/0312225). Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places where the Toffoli gate is uncomputed again. @@ -173,19 +173,19 @@ python_api_name: qiskit.circuit.library.RCCXGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return instruction label **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### params - + return instruction params. @@ -357,7 +357,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.mdx index c5c355802ab..55998191048 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # qiskit.circuit.library.RGQFTMultiplier - + A QFT multiplication circuit to store product of two input registers out-of-place. Multiplication in this circuit is implemented using the procedure of Fig. 3 in \[1], where weighted sum rotations are implemented as given in Fig. 5 in \[1]. QFT is used on the output register and is followed by rotations controlled by input registers. The rotations transform the state into the product of two input registers in QFT base, which is reverted from QFT base using inverse QFT. As an example, a circuit that performs a modular QFT multiplication on two 2-qubit sized input registers with an output register of 2 qubits, is as follows: @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -414,7 +414,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -460,19 +460,19 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### data - + Return the circuit data (instructions and context). **Returns** @@ -904,7 +904,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -922,7 +922,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -958,7 +958,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### global\_phase - + Return the global phase of the circuit in radians. @@ -1373,7 +1373,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1387,13 +1387,13 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1425,19 +1425,19 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_result\_qubits - + The number of result qubits to limit the output to. **Return type** @@ -1451,7 +1451,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### num\_state\_qubits - + The number of state qubits, i.e. the number of bits in each input register. **Return type** @@ -1487,7 +1487,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1635,7 +1635,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.mdx index 80a73920727..6676074a599 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # qiskit.circuit.library.RGate - + Rotation θ around the cos(φ)x + sin(φ)y axis. **Circuit symbol:** @@ -187,19 +187,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -219,7 +219,7 @@ $$ ### label - + Return instruction label **Return type** @@ -245,7 +245,7 @@ $$ ### params - + return instruction params. @@ -357,7 +357,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.mdx index 6defe4c2051..33b66059763 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # qiskit.circuit.library.RVGate - + Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. **Circuit symbol:** @@ -203,19 +203,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -233,7 +233,7 @@ $$ ### label - + Return instruction label **Return type** @@ -259,7 +259,7 @@ $$ ### params - + return instruction params. @@ -359,7 +359,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.mdx index 8bb7deaaed4..3ccdb1b244b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # qiskit.circuit.library.RXGate - + Single-qubit rotation about the X axis. **Circuit symbol:** @@ -183,19 +183,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -215,7 +215,7 @@ $$ ### label - + Return instruction label **Return type** @@ -241,7 +241,7 @@ $$ ### params - + return instruction params. @@ -353,7 +353,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.mdx index b46c835be03..27619202260 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # qiskit.circuit.library.RXXGate - + A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -213,19 +213,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return instruction label **Return type** @@ -269,7 +269,7 @@ $$ ### params - + return instruction params. @@ -381,7 +381,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.mdx index b39bbe9d120..e309e237eb4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # qiskit.circuit.library.RYGate - + Single-qubit rotation about the Y axis. **Circuit symbol:** @@ -183,19 +183,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -215,7 +215,7 @@ $$ ### label - + Return instruction label **Return type** @@ -241,7 +241,7 @@ $$ ### params - + return instruction params. @@ -353,7 +353,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.mdx index a617d348b69..3e9a7765dd4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # qiskit.circuit.library.RYYGate - + A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -213,19 +213,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -243,7 +243,7 @@ $$ ### label - + Return instruction label **Return type** @@ -269,7 +269,7 @@ $$ ### params - + return instruction params. @@ -381,7 +381,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.mdx index 6ac94190526..6ab07e01a7d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # qiskit.circuit.library.RZGate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -195,19 +195,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -227,7 +227,7 @@ $$ ### label - + Return instruction label **Return type** @@ -253,7 +253,7 @@ $$ ### params - + return instruction params. @@ -365,7 +365,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.mdx index 7157138d196..39600378e2c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # qiskit.circuit.library.RZXGate - + A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). This gate is maximally entangling at $\theta = \pi/2$. @@ -251,19 +251,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -281,7 +281,7 @@ $$ ### label - + Return instruction label **Return type** @@ -307,7 +307,7 @@ $$ ### params - + return instruction params. @@ -419,7 +419,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.mdx index abd3e876499..c68cc2ee264 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # qiskit.circuit.library.RZZGate - + A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). This gate is symmetric, and is maximally entangling at $\theta = \pi/2$. @@ -225,19 +225,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -255,7 +255,7 @@ $$ ### label - + Return instruction label **Return type** @@ -281,7 +281,7 @@ $$ ### params - + return instruction params. @@ -393,7 +393,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.mdx index c75b4ee3fe9..abaffdd8dec 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # qiskit.circuit.library.RealAmplitudes - + The real-amplitudes 2-local circuit. The `RealAmplitudes` circuit is a heuristic trial wave function used as Ansatz in chemistry applications or classification circuits in machine learning. The circuit consists of of alternating layers of $Y$ rotations and $CX$ entanglements. The entanglement pattern can be user-defined or selected from a predefined set. It is called `RealAmplitudes` since the prepared quantum states will only have real amplitudes, the complex part is always 0. @@ -360,7 +360,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -443,7 +443,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -453,7 +453,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -489,19 +489,19 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -720,7 +720,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + Return the circuit data (instructions and context). **Returns** @@ -901,7 +901,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -915,7 +915,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -961,7 +961,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -979,7 +979,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1039,7 +1039,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### global\_phase - + Return the global phase of the circuit in radians. @@ -1087,7 +1087,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1217,7 +1217,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1482,7 +1482,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1496,13 +1496,13 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1526,7 +1526,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1548,7 +1548,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1558,7 +1558,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1578,7 +1578,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1608,7 +1608,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1644,7 +1644,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -1658,7 +1658,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1699,7 +1699,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1770,7 +1770,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qregs - + A list of the quantum registers associated with the circuit. @@ -1844,7 +1844,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1906,7 +1906,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2012,7 +2012,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.mdx index 8c8d964d8fb..6c8b7eea4d5 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # qiskit.circuit.library.Reset - + Qubit reset. Create new reset instruction. @@ -108,19 +108,19 @@ python_api_name: qiskit.circuit.library.Reset ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.library.Reset ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.Reset ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.Reset ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.mdx index 7bb5af180a2..313e58b0d19 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # qiskit.circuit.library.SGate - + Single qubit S gate (Z\*\*0.5). It induces a $\pi/2$ phase, and is sometimes called the P gate (phase). @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.mdx index 9d05049e796..90b798e2a5a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # qiskit.circuit.library.SXGate - + The single-qubit Sqrt(X) gate ($\sqrt{X}$). **Matrix Representation:** @@ -196,19 +196,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -226,7 +226,7 @@ $$ ### label - + Return instruction label **Return type** @@ -252,7 +252,7 @@ $$ ### params - + return instruction params. @@ -364,7 +364,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.mdx index 07746986e1e..69495043d44 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # qiskit.circuit.library.SXdgGate - + The inverse single-qubit Sqrt(X) gate. $$ @@ -188,19 +188,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -218,7 +218,7 @@ $$ ### label - + Return instruction label **Return type** @@ -244,7 +244,7 @@ $$ ### params - + return instruction params. @@ -356,7 +356,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.mdx index de61d962682..8c05f0428e8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # qiskit.circuit.library.SdgGate - + Single qubit S-adjoint gate (\~Z\*\*0.5). It induces a $-\pi/2$ phase. @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.mdx index cd797e85383..3eac69280b2 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # qiskit.circuit.library.SwapGate - + The SWAP gate. This is a symmetric and Clifford gate. @@ -195,19 +195,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -225,7 +225,7 @@ $$ ### label - + Return instruction label **Return type** @@ -251,7 +251,7 @@ $$ ### params - + return instruction params. @@ -363,7 +363,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.mdx index 57e455a1e78..968d517da0b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # qiskit.circuit.library.TGate - + Single qubit T gate (Z\*\*0.25). It induces a $\pi/4$ phase, and is sometimes called the pi/8 gate (because of how the RZ(pi/4) matrix looks like). @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.mdx index 243fbaf7dd3..09038c74268 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # qiskit.circuit.library.TdgGate - + Single qubit T-adjoint gate (\~Z\*\*0.25). It induces a $-\pi/4$ phase. @@ -192,19 +192,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -222,7 +222,7 @@ $$ ### label - + Return instruction label **Return type** @@ -248,7 +248,7 @@ $$ ### params - + return instruction params. @@ -360,7 +360,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.mdx index f4cbbf7a32a..085e6ce473c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # qiskit.circuit.library.TwoLocal - + The two-local circuit. The two-local circuit is a parameterized circuit consisting of alternating rotation layers and entanglement layers. The rotation layers are single qubit gates applied on all qubits. The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set using `entanglement`. Both the rotation and entanglement gates can be specified as string (e.g. `'ry'` or `'cx'`), as gate-type (e.g. `RYGate` or `CXGate`) or as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit). @@ -382,7 +382,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -465,7 +465,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -475,7 +475,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -511,19 +511,19 @@ python_api_name: qiskit.circuit.library.TwoLocal ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -742,7 +742,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + Return the circuit data (instructions and context). **Returns** @@ -923,7 +923,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -937,7 +937,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -983,7 +983,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1001,7 +1001,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1061,7 +1061,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### global\_phase - + Return the global phase of the circuit in radians. @@ -1109,7 +1109,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1239,7 +1239,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1504,7 +1504,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1518,13 +1518,13 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1548,7 +1548,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1570,7 +1570,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1580,7 +1580,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters\_settable - + The number of total parameters that can be set to distinct values. This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. @@ -1600,7 +1600,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1630,7 +1630,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1666,7 +1666,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1680,7 +1680,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1721,7 +1721,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1792,7 +1792,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qregs - + A list of the quantum registers associated with the circuit. @@ -1866,7 +1866,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1928,7 +1928,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2034,7 +2034,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.mdx index ef3a4630af2..05dd270ce22 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # qiskit.circuit.library.U1Gate - + Single-qubit rotation about the Z axis. This is a diagonal gate. It can be implemented virtually in hardware via framechanges (i.e. at zero error and duration). @@ -211,19 +211,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -241,7 +241,7 @@ $$ ### label - + Return instruction label **Return type** @@ -267,7 +267,7 @@ $$ ### params - + return instruction params. @@ -379,7 +379,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.mdx index f7a8e273dc6..bf9b8541067 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # qiskit.circuit.library.U2Gate - + Single-qubit rotation about the X+Z axis. Implemented using one X90 pulse on IBM Quantum systems: @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -237,7 +237,7 @@ $$ ### label - + Return instruction label **Return type** @@ -263,7 +263,7 @@ $$ ### params - + return instruction params. @@ -375,7 +375,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.mdx index 83fb86f32b0..a96f60e128a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # qiskit.circuit.library.U3Gate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -232,7 +232,7 @@ $$ ### label - + Return instruction label **Return type** @@ -258,7 +258,7 @@ $$ ### params - + return instruction params. @@ -370,7 +370,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.mdx index 454ea799a1d..54066a3f0c7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # qiskit.circuit.library.UGate - + Generic single-qubit rotation gate with 3 Euler angles. Implemented using two X90 pulses on IBM Quantum systems: @@ -200,19 +200,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -232,7 +232,7 @@ $$ ### label - + Return instruction label **Return type** @@ -258,7 +258,7 @@ $$ ### params - + return instruction params. @@ -370,7 +370,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.mdx index a3fd2f545a4..01253696bed 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # qiskit.circuit.library.UniformDistribution - + A circuit to encode a discretized uniform distribution in qubit amplitudes. This simply corresponds to applying Hadamard gates on all qubits. @@ -255,7 +255,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -417,7 +417,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -427,7 +427,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -463,19 +463,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -694,7 +694,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -907,7 +907,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -925,7 +925,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -961,7 +961,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1376,7 +1376,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1390,13 +1390,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1428,13 +1428,13 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1462,7 +1462,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1610,7 +1610,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.mdx index 3b01fd55d66..be8a2ed44ff 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # qiskit.circuit.library.VBERippleCarryAdder - + The VBE ripple carry adder \[1]. This circuit performs inplace addition of two equally-sized quantum registers. As an example, a classical adder circuit that performs full addition (i.e. including a carry-in bit) on two 2-qubit sized registers is as follows: @@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -426,7 +426,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -436,7 +436,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -472,19 +472,19 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -703,7 +703,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### data - + Return the circuit data (instructions and context). **Returns** @@ -916,7 +916,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -970,7 +970,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### global\_phase - + Return the global phase of the circuit in radians. @@ -1385,7 +1385,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1399,13 +1399,13 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1437,19 +1437,19 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of state qubits, i.e. the number of bits in each input register. **Return type** @@ -1485,7 +1485,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1633,7 +1633,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.mdx index 38a77ee0132..abc86a0ec6c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # qiskit.circuit.library.WeightedAdder - + A circuit to compute the weighted sum of qubit registers. Given $n$ qubit basis states $q_0, \ldots, q_{n-1} \in \{0, 1\}$ and non-negative integer weights $\lambda_0, \ldots, \lambda_{n-1}$, this circuit performs the operation @@ -281,7 +281,7 @@ $$ ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -443,7 +443,7 @@ $$ ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -453,7 +453,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -489,19 +489,19 @@ $$ ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -720,7 +720,7 @@ $$ ### data - + Return the circuit data (instructions and context). **Returns** @@ -933,7 +933,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -951,7 +951,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -987,7 +987,7 @@ $$ ### global\_phase - + Return the global phase of the circuit in radians. @@ -1402,7 +1402,7 @@ $$ ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1416,7 +1416,7 @@ $$ ### num\_ancilla\_qubits - + Deprecated. Use num\_ancillas instead. **Return type** @@ -1426,13 +1426,13 @@ $$ ### num\_ancillas - + Return the number of ancilla qubits. ### num\_carry\_qubits - + The number of carry qubits required to compute the sum. Note that this is not necessarily equal to the number of ancilla qubits, these can be queried using `num_ancilla_qubits`. @@ -1448,7 +1448,7 @@ $$ ### num\_clbits - + Return number of classical bits. @@ -1472,7 +1472,7 @@ $$ ### num\_control\_qubits - + The number of additional control qubits required. Note that the total number of ancilla qubits can be obtained by calling the method `num_ancilla_qubits`. @@ -1496,7 +1496,7 @@ $$ ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1506,13 +1506,13 @@ $$ ### num\_qubits - + Return number of qubits. ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -1526,7 +1526,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -1562,7 +1562,7 @@ $$ ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1646,7 +1646,7 @@ $$ ### qregs - + A list of the quantum registers associated with the circuit. @@ -1720,7 +1720,7 @@ $$ ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -2870,7 +2870,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.mdx index b4eb8e94228..cb8963bb9b2 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # qiskit.circuit.library.XGate - + The single-qubit Pauli-X gate ($\sigma_x$). **Matrix Representation:** @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -235,7 +235,7 @@ $$ ### label - + Return instruction label **Return type** @@ -261,7 +261,7 @@ $$ ### params - + return instruction params. @@ -373,7 +373,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.mdx index 596c699b6f6..33af49d2d27 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # qiskit.circuit.library.XOR - + An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. The `amount` is xor-ed in bitstring form with the input. @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.library.XOR ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -412,7 +412,7 @@ python_api_name: qiskit.circuit.library.XOR ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -422,7 +422,7 @@ python_api_name: qiskit.circuit.library.XOR ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -458,19 +458,19 @@ python_api_name: qiskit.circuit.library.XOR ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -689,7 +689,7 @@ python_api_name: qiskit.circuit.library.XOR ### data - + Return the circuit data (instructions and context). **Returns** @@ -902,7 +902,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -920,7 +920,7 @@ python_api_name: qiskit.circuit.library.XOR ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -956,7 +956,7 @@ python_api_name: qiskit.circuit.library.XOR ### global\_phase - + Return the global phase of the circuit in radians. @@ -1371,7 +1371,7 @@ python_api_name: qiskit.circuit.library.XOR ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1385,13 +1385,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1423,13 +1423,13 @@ python_api_name: qiskit.circuit.library.XOR ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. ### num\_qubits - + Return number of qubits. @@ -1457,7 +1457,7 @@ python_api_name: qiskit.circuit.library.XOR ### parameters - + Convenience function to get the parameters defined in the parameter table. @@ -1605,7 +1605,7 @@ python_api_name: qiskit.circuit.library.XOR ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.mdx index 7f8da9b00f9..8b689fcb6ae 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # qiskit.circuit.library.YGate - + The single-qubit Pauli-Y gate ($\sigma_y$). **Matrix Representation:** @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -235,7 +235,7 @@ $$ ### label - + Return instruction label **Return type** @@ -261,7 +261,7 @@ $$ ### params - + return instruction params. @@ -373,7 +373,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.mdx index 7042fe5ec28..b65dac3e568 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # qiskit.circuit.library.ZFeatureMap - + The first order Pauli Z-evolution circuit. On 3 qubits and with 2 repetitions the circuit is represented by: @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -347,7 +347,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -430,7 +430,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -440,7 +440,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -476,19 +476,19 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -707,7 +707,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -888,7 +888,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -902,7 +902,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -938,7 +938,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -958,7 +958,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -976,7 +976,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1056,7 +1056,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1104,7 +1104,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1234,7 +1234,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1513,13 +1513,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1543,7 +1543,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1565,7 +1565,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1575,13 +1575,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1611,7 +1611,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1647,7 +1647,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1661,7 +1661,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1689,7 +1689,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1728,7 +1728,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1799,7 +1799,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1873,7 +1873,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1935,7 +1935,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2041,7 +2041,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.mdx index 7514b6dcf33..97a6d9f92a6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # qiskit.circuit.library.ZGate - + The single-qubit Pauli-Z gate ($\sigma_z$). **Matrix Representation:** @@ -205,19 +205,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -235,7 +235,7 @@ $$ ### label - + Return instruction label **Return type** @@ -261,7 +261,7 @@ $$ ### params - + return instruction params. @@ -373,7 +373,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.mdx index 0f73e25f975..b10f685f747 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # qiskit.circuit.library.ZZFeatureMap - + Second-order Pauli-Z evolution circuit. For 3 qubits and 1 repetition and linear entanglement the circuit is represented by: @@ -329,7 +329,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### alpha - + The Pauli rotation factor (alpha). **Return type** @@ -343,7 +343,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -426,7 +426,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -436,7 +436,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -472,19 +472,19 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -703,7 +703,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + Return the circuit data (instructions and context). **Returns** @@ -884,7 +884,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -898,7 +898,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + The blocks in the entanglement layers. **Returns** @@ -934,7 +934,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -954,7 +954,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -972,7 +972,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1052,7 +1052,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### global\_phase - + Return the global phase of the circuit in radians. @@ -1100,7 +1100,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -1230,7 +1230,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -1495,7 +1495,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1509,13 +1509,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1539,7 +1539,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -1561,7 +1561,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1571,13 +1571,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters\_settable - + The number of distinct parameters. ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1607,7 +1607,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -1643,7 +1643,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -1657,7 +1657,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Convenience function to get the parameters defined in the parameter table. **Return type** @@ -1685,7 +1685,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -1724,7 +1724,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -1795,7 +1795,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qregs - + A list of the quantum registers associated with the circuit. @@ -1869,7 +1869,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### qubits - + Returns a list of quantum bits in the order that the registers were added. @@ -1931,7 +1931,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -2037,7 +2037,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### rotation\_blocks - + The blocks in the rotation layers. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.mdx index 5164d6f2f5b..fd5ab5182cd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # qiskit.circuit.library.iSwapGate - + iSWAP gate. A 2-qubit XX+YY interaction. This is a Clifford and symmetric gate. Its action is to swap two qubit states and phase the $|01\rangle$ and $|10\rangle$ amplitudes by i. @@ -220,19 +220,19 @@ $$ ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -266,7 +266,7 @@ $$ ### label - + Return instruction label **Return type** @@ -292,7 +292,7 @@ $$ ### params - + return instruction params. @@ -404,7 +404,7 @@ $$ ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.mdx index 26669d9b324..9b27202ee7d 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # qiskit.dagcircuit.DAGCircuit - + Quantum circuit as a directed acyclic graph. There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits. @@ -203,7 +203,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -346,7 +346,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** @@ -391,7 +391,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### global\_phase - + Return the global phase of the circuit. @@ -483,7 +483,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### node\_counter - + Returns the number of nodes in the dag. @@ -750,7 +750,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### wires - + Return a list of the wires in order. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.mdx index b33128ab90c..4316b50a113 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.mdx index e009af60205..daa9b788422 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # qiskit.dagcircuit.DAGDepNode - + Object to represent the information at a node in the DAGDependency(). It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -50,7 +50,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### condition - + Returns the condition of the node.op @@ -62,19 +62,19 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.mdx index b7693eb3410..30cbeb0713a 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # qiskit.dagcircuit.DAGDependency - + Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed. @@ -114,7 +114,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -293,7 +293,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency ### global\_phase - + Return the global phase of the circuit. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.mdx index 67402108c84..7f9ab609386 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # qiskit.dagcircuit.DAGNode - + Object to represent the information at a node in the DAGCircuit. It is used as the return value from \*\_nodes() functions and can be supplied to functions that take a node. @@ -43,31 +43,31 @@ python_api_name: qiskit.dagcircuit.DAGNode ### condition - + Returns the condition of the node.op ### name - + Returns the Instruction name corresponding to the op for this node ### op - + Returns the Instruction object corresponding to the op for the node, else None ### qargs - + Returns list of Qubit, else an empty list. ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** @@ -88,7 +88,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### wire - + Returns the Bit object, else None. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.mdx index ebe0f1ac8a8..bf2c862da98 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # qiskit.extensions.HamiltonianGate - + Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. Create a gate from a hamiltonian operator and evolution time parameter t @@ -204,19 +204,19 @@ python_api_name: qiskit.extensions.HamiltonianGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -234,7 +234,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return instruction label **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### params - + return instruction params. @@ -376,7 +376,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.28/qiskit.extensions.Initialize.mdx index 0640f830199..6b58b40c96b 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.28/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # qiskit.extensions.Initialize - + Complex amplitude initialization. Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers. Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary. @@ -147,19 +147,19 @@ python_api_name: qiskit.extensions.Initialize ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -207,7 +207,7 @@ python_api_name: qiskit.extensions.Initialize ### label - + Return instruction label **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.extensions.Initialize ### params - + return instruction params. @@ -305,7 +305,7 @@ python_api_name: qiskit.extensions.Initialize ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.mdx index 1e74f25f9dd..45cbaae0e45 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # qiskit.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -133,19 +133,19 @@ python_api_name: qiskit.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -163,7 +163,7 @@ python_api_name: qiskit.extensions.Snapshot ### label - + Return snapshot label @@ -185,7 +185,7 @@ python_api_name: qiskit.extensions.Snapshot ### params - + return instruction params. @@ -239,7 +239,7 @@ python_api_name: qiskit.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -263,7 +263,7 @@ python_api_name: qiskit.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.mdx index 213af92f197..5708a6cd49c 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # qiskit.extensions.UnitaryGate - + Class for representing unitary gates Create a gate from a numeric unitary matrix. @@ -203,19 +203,19 @@ python_api_name: qiskit.extensions.UnitaryGate ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -233,7 +233,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return instruction label **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### params - + return instruction params. @@ -375,7 +375,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.mdx index ec0d88deb2b..1fc4c51b85a 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index d7f67001b29..6eb9cad9b70 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # qiskit.finance.components.uncertainty\_problems.EuropeanCallDelta - + The European Call Option Delta. Evaluates the variance for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -151,7 +151,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index 6fb62e94231..29664f6cbe0 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # qiskit.finance.components.uncertainty\_problems.EuropeanCallExpectedValue - + The European Call Option Expected Value. Evaluates the expected payoff for a European call option given an uncertainty model. The payoff function is f(S, K) = max(0, S - K) for a spot price S and strike price K. @@ -155,7 +155,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index 9146304c8eb..743382d8479 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # qiskit.finance.components.uncertainty\_problems.FixedIncomeExpectedValue - + The Fixed Income Expected Value. Evaluates a fixed income asset with uncertain interest rates. @@ -157,7 +157,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec ### num\_target\_qubits - + Returns the number of target qubits diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.mdx index b12af8df2e6..f94fc28a515 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # qiskit.finance.data\_providers.BaseDataProvider - + The abstract base class for data\_provider modules within Qiskit’s finance module. To create add-on data\_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented. @@ -17,7 +17,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### \_\_init\_\_ - + Initialize self. See help(type(self)) for accurate signature. @@ -136,7 +136,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.mdx index fbf9b10dd1d..1c540f4e596 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # qiskit.finance.data\_providers.DataOnDemandProvider - + NASDAQ Data on Demand data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.mdx index 62a79450642..81ea451df61 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # qiskit.finance.data\_providers.ExchangeDataProvider - + Exchange data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use, which involve obtaining a Quandl access token. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.mdx index 4d9c5fbfb65..b204dd97849 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # qiskit.finance.data\_providers.RandomDataProvider - + Pseudo-randomly generated mock stock-market data provider. Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param tickers: tickers :type start: `datetime` :param start: first data point :type end: `datetime` :param end: last data point precedes this date :type seed: `Optional`\[`int`] :param seed: shall a seed be used? diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.mdx index dd8223e6cd4..d15da364bae 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # qiskit.finance.data\_providers.StockMarket - + Stock Market enum ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 023b8271d31..e835736bd3a 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # qiskit.finance.data\_providers.WikipediaDataProvider - + Wikipedia data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.mdx index 7191e3eb1c2..6127b66fd16 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # qiskit.finance.data\_providers.YahooDataProvider - + Yahoo data provider. Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11\_time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/finance/11_time_series.ipynb) for instructions on use. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.mdx index f3d425d3b47..0fcf9661fcc 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # qiskit.ignis.characterization.AmpCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.mdx index 81c6416d1a0..3895433f18f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # qiskit.ignis.characterization.AmpCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 5cae1dd86fb..835a2557461 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # qiskit.ignis.characterization.AngleCalCXFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.mdx index eff4166e29e..6da3dd6f598 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # qiskit.ignis.characterization.AngleCalFitter - + Amplitude error fitter See BaseFitter \_\_init\_\_ @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -185,7 +185,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -195,7 +195,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 3f7298c8cac..6c1f702e96d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # qiskit.ignis.characterization.BaseCoherenceFitter - + Base class for fitters of characteristic times **Parameters** @@ -71,7 +71,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -126,7 +126,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -136,7 +136,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.mdx index 67337efff90..e3b8343d1fc 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # qiskit.ignis.characterization.BaseGateFitter - + Base class for fitters of gate errors See BaseFitter \_\_init\_\_ @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.mdx index c6d8618859b..96fea6f87d2 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # qiskit.ignis.characterization.DragFitter - + Drag Experiment fitter See IQFitter \_\_init\_\_ @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -155,7 +155,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.mdx index 451250e59f0..130ea82fb23 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # qiskit.ignis.characterization.RabiFitter - + Rabi Experiment fitter See BaseCalibrationFitter \_\_init\_\_ @@ -63,7 +63,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -148,7 +148,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.mdx index f891073becd..c637555fae3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # qiskit.ignis.characterization.T1Fitter - + Estimate T1, based on experiments outcomes, The experiments were created by t1\_circuits, and executed on the device. @@ -75,7 +75,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -85,7 +85,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -110,7 +110,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -120,7 +120,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -130,7 +130,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -140,7 +140,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -175,7 +175,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -223,7 +223,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -233,7 +233,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.mdx index 48c153a777b..1b5f329eb5f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # qiskit.ignis.characterization.T2Fitter - + Estimate T2, based on experiments outcomes. The experiments were created by t2\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -176,7 +176,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -224,7 +224,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -234,7 +234,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.mdx index c32236e17fd..d3fed73eabd 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # qiskit.ignis.characterization.T2StarFitter - + Estimate T2\*, based on experiments outcomes. The experiments were created by t2star\_circuits, and executed on the device. @@ -76,7 +76,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -139,7 +139,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -149,7 +149,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -159,7 +159,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -194,7 +194,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -242,7 +242,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -252,7 +252,7 @@ $$ ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.mdx index 07adf6c7edb..ff69a1f4e7f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # qiskit.ignis.characterization.ZZFitter - + ZZ fitter ### \_\_init\_\_ @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -86,7 +86,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -141,7 +141,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### ydata - + Return the data points on the y-axis The data points are returning in the form of a list of dictionaries: diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.mdx index d9f7edb1ce8..19a3582b148 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # qiskit.ignis.logging.IgnisLogReader - + Class to read from Ignis log files Reads and constructs tabular representation of logged data based on date/time and key criteria diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.mdx index 59417cb2165..b6e9c3ba0a3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # qiskit.ignis.logging.IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.mdx index 1fc8c56fc0e..1adb06a713e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # qiskit.ignis.logging.IgnisLogging - + Singleton class to configure file logging via IgnisLogger Logging to file is enabled only if there is a config file present. Otherwise IgnisLogger will behave as a regular logger. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.mdx index 77dafde2131..5625ef587c9 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # qiskit.ignis.measurement.DiscriminationFilter - + Implements a filter based on a discriminator that takes level 1 data to level 2 data. **Usage:** @@ -76,7 +76,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 231150bc93a..c3f15566789 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # qiskit.ignis.measurement.IQDiscriminationFitter - + Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -85,19 +85,19 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### expected\_states - + Returns the expected states used to train the discriminator. ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. ### fitted - + True if the discriminator has been fitted to calibration data. @@ -236,7 +236,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 960417a844c..1cc340b8f18 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # qiskit.ignis.measurement.LinearIQDiscriminator - + Linear discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index deca26b8d9b..63dcc749e1b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # qiskit.ignis.measurement.QuadraticIQDiscriminator - + Quadratic discriminant analysis discriminator for IQ data. **Parameters** @@ -95,7 +95,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -107,7 +107,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -246,7 +246,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index 3198ef0729f..bb38c72f3ac 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # qiskit.ignis.measurement.SklearnIQDiscriminator - + A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### expected\_states - + Returns the expected states used to train the discriminator. @@ -99,7 +99,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### fitted - + True if the discriminator has been fitted to calibration data. @@ -238,7 +238,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator ### schedules - + Returns the schedules with which the discriminator was fitted. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index b32b4fedc2b..f3bdad81056 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # qiskit.ignis.mitigation.CTMPExpvalMeasMitigator - + N-qubit CTMP measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 2c346fc747f..41bc15188f2 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # qiskit.ignis.mitigation.CompleteExpvalMeasMitigator - + N-qubit measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index edb0220a002..311cfe9dff7 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # qiskit.ignis.mitigation.CompleteMeasFitter - + Measurement correction fitter for a full calibration Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits @@ -69,13 +69,13 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### cal\_matrix - + Return cal\_matrix. ### filter - + Return a measurement filter using the cal matrix. @@ -92,7 +92,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### qubit\_list - + Return list of qubits. @@ -120,7 +120,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter ### state\_labels - + Return state\_labels. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index bba1c825c89..5d4e0fb721e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter - + Expectation value measurement error mitigator calibration fitter. See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. @@ -56,7 +56,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter ### mitigator - + Return the fitted mitigator object diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.mdx index bad192ad4c9..4e49d3d9ca9 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # qiskit.ignis.mitigation.MeasurementFilter - + Measurement error mitigation filter. Produced from a measurement calibration fitter and can be applied to data. @@ -87,13 +87,13 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter ### cal\_matrix - + Return cal\_matrix. ### state\_labels - + return the state label ordering of the cal matrix diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index 1bf39854ce1..2393eb6c6a4 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # qiskit.ignis.mitigation.TensoredExpvalMeasMitigator - + 1-qubit tensor product measurement error mitigator. This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.mdx index e95839c22a7..4ea9dd389a6 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # qiskit.ignis.mitigation.TensoredFilter - + Tensored measurement error mitigation filter. Produced from a tensored measurement calibration fitter and can be applied to data. @@ -106,7 +106,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### cal\_matrices - + Return cal\_matrices. @@ -132,19 +132,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter ### nqubits - + Return the number of qubits. See also MeasurementFilter.apply() ### qubit\_list\_sizes - + Return \_qubit\_list\_sizes. ### substate\_labels\_list - + Return \_substate\_labels\_list diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index d8f51cfe1c5..86f411e4057 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # qiskit.ignis.mitigation.TensoredMeasFitter - + Measurement correction fitter for a tensored calibration. Initialize a measurement calibration matrix from the results of running the circuits returned by measurement\_calibration\_circuits. @@ -72,19 +72,19 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### cal\_matrices - + Return cal\_matrices. ### filter - + Return a measurement filter using the cal matrices. ### nqubits - + Return \_qubit\_list\_sizes. @@ -134,7 +134,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter ### substate\_labels\_list - + Return \_substate\_labels\_list. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.mdx index 1e10b61f70d..ab2a0651a33 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # qiskit.ignis.verification.AccreditationCircuits - + This class generates accreditation circuits from a target. Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.mdx index cd548abfdec..ff65a5b3863 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # qiskit.ignis.verification.AccreditationFitter - + Class for fitters for accreditation Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis and Animesh Datta New Journal of Physics, Volume 21, November 2019 [https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6](https://iopscience.iop.org/article/10.1088/1367-2630/ab4fd6) diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.mdx index 2674216d626..dd4551bc7e5 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # qiskit.ignis.verification.BConfig - + This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.mdx index bd0c0a1a877..95b3cd56284 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # qiskit.ignis.verification.CNOTDihedral - + CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. **References** @@ -116,7 +116,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -204,13 +204,13 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### key - + Return a string representation of a CNOT-dihedral object. ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -250,7 +250,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### qargs - + Return the qargs for the operator. @@ -280,7 +280,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 53779d9ea3f..e17ccfa97fb 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # qiskit.ignis.verification.CNOTDihedralRBFitter - + Class for fitters for non-Clifford CNOT-Dihedral RB. Derived from RBFitterBase class. Contains two RBFitter objects. @@ -88,19 +88,19 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### cliff\_lengths - + Return group elements lengths. ### fit - + Return fit as a 2 element list. ### fit\_cnotdihedral - + Return cnotdihedral fit parameters. @@ -158,43 +158,43 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter ### raw\_data - + Return raw\_data as 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_X - + Return the cnotdihedral X fitter. ### rbfit\_Z - + Return the cnotdihedral Z fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.mdx index bef77c48908..8c6b3996733 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # qiskit.ignis.verification.GatesetTomographyFitter - + Initialize gateset tomography fitter with experimental data. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.mdx index 9034971fc56..5a181f0ceab 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # qiskit.ignis.verification.GraphDecoder - + Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.mdx index 18c3ddd3b1a..d0763c4eb6a 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # qiskit.ignis.verification.InterleavedRBFitter - + Class for fitters for interleaved RB, derived from RBFitterBase class. Contains two RBFitter objects: the original RBFitter and the interleaved RBFitter. @@ -92,13 +92,13 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit as a 2 element list. @@ -132,7 +132,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### fit\_int - + Return interleaved fit parameters. @@ -155,43 +155,43 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter ### raw\_data - + Return raw\_data as a 2 element list. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_int - + Return the interleaved RB fitter. ### rbfit\_std - + Return the original RB fitter. ### results - + Return all the results as a 2 element list. ### seeds - + Return the number of loaded seeds as a 2 element list. ### ydata - + Return ydata (means and std devs) as a 2 element list. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.mdx index 5b2620265c2..58a4ad6472e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # qiskit.ignis.verification.Plotter - + Various plots of the ground state in MQC and PO experiments ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 4986354d75e..8efae59b513 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # qiskit.ignis.verification.ProcessTomographyFitter - + Maximum-Likelihood estimation process tomography fitter. Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### data - + Return tomography data @@ -146,13 +146,13 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.mdx index e158e83ebb6..034e74b0c4f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # qiskit.ignis.verification.PurityRBFitter - + Class for fitter for purity RB. Derived from RBFitterBase class. @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -112,13 +112,13 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return the purity fit parameters. @@ -161,37 +161,37 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### rbfit\_pur - + Return the purity RB fitter. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.mdx index 155d27ff3fb..5cfe7c30e9d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # qiskit.ignis.verification.QVFitter - + Class for fitters for quantum volume. **Parameters** @@ -152,25 +152,25 @@ python_api_name: qiskit.ignis.verification.QVFitter ### depths - + Return depth list. ### heavy\_output\_counts - + Return the number of heavy output counts as measured. ### heavy\_output\_prob\_ideal - + Return the heavy output probability ideally. ### heavy\_outputs - + Return the ideal heavy outputs dictionary. @@ -254,7 +254,7 @@ python_api_name: qiskit.ignis.verification.QVFitter ### qubit\_lists - + Return depth list. @@ -274,13 +274,13 @@ python_api_name: qiskit.ignis.verification.QVFitter ### results - + Return all the results. ### ydata - + Return the average and std of the output probability. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.mdx index 685ea07071c..985a5a4a60a 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # qiskit.ignis.verification.RBFitter - + Class for fitters for randomized benchmarking. **Parameters** @@ -91,13 +91,13 @@ python_api_name: qiskit.ignis.verification.RBFitter ### cliff\_lengths - + Return clifford lengths. ### fit - + Return fit. @@ -151,31 +151,31 @@ python_api_name: qiskit.ignis.verification.RBFitter ### raw\_data - + Return raw data. ### rb\_fit\_fun - + Return the fit function rb\_fit\_fun. ### results - + Return all the results. ### seeds - + Return the number of loaded seeds. ### ydata - + Return ydata (means and std devs). diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.mdx index 8e0aa13fe2f..c6f3feb5f1d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # qiskit.ignis.verification.RepetitionCode - + Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. Creates the circuits corresponding to a logical 0 and 1 encoded using a repetition code. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.mdx index 40c093860dc..4b648fd4806 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # qiskit.ignis.verification.StateTomographyFitter - + Maximum-Likelihood estimation state tomography fitter. Initialize state tomography fitter with experimental data. @@ -66,7 +66,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### data - + Return tomography data @@ -134,13 +134,13 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.mdx index 210024aa6c3..e726f44185c 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # qiskit.ignis.verification.TomographyFitter - + Base maximum-likelihood estimate tomography fitter class Initialize tomography fitter with experimental data. @@ -68,7 +68,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### data - + Return tomography data @@ -139,13 +139,13 @@ python_api_name: qiskit.ignis.verification.TomographyFitter ### measure\_basis - + Return the tomography measurement basis. ### preparation\_basis - + Return the tomography preparation basis. diff --git a/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.mdx index 1b74abf52cc..cc7f9df7ecc 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # qiskit.ml.circuit.library.RawFeatureVector - + The raw feature vector circuit. This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. @@ -263,7 +263,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ancillas - + Returns a list of ancilla bits in the order that the registers were added. @@ -312,7 +312,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### calibrations - + Return calibration dictionary. **The custom pulse definition of a given gate is of the form** @@ -322,7 +322,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -358,19 +358,19 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### clbits - + Returns a list of classical bits in the order that the registers were added. ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -589,7 +589,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### data - + Return the circuit data (instructions and context). **Returns** @@ -796,7 +796,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### feature\_dimension - + Return the feature dimension. **Return type** @@ -816,7 +816,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -834,7 +834,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -870,7 +870,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### global\_phase - + Return the global phase of the circuit in radians. @@ -1285,7 +1285,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### metadata - + The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. @@ -1299,13 +1299,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_ancillas - + Return the number of ancilla qubits. ### num\_clbits - + Return number of classical bits. @@ -1337,7 +1337,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_parameters - + Convenience function to get the number of parameter objects in the circuit. **Return type** @@ -1347,7 +1347,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -1377,7 +1377,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### ordered\_parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1397,7 +1397,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### parameters - + Return the free parameters in the RawFeatureVector. **Return type** @@ -1485,7 +1485,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qregs - + A list of the quantum registers associated with the circuit. @@ -1559,7 +1559,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### qubits - + Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.mdx index 38dd5aec465..c1ced4a1007 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # qiskit.opflow\.OperatorBase - + A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. Operators can be used to construct complicated functions and computation, and serve as the building blocks for algorithms. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -171,7 +171,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -191,7 +191,7 @@ python_api_name: qiskit.opflow.OperatorBase ### instance\_id - + Return the unique instance id. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -247,13 +247,13 @@ python_api_name: qiskit.opflow.OperatorBase ### parameters - + Return a set of Parameter objects contained in the Operator. ### permute - + Permutes the qubits of the operator. **Parameters** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -305,7 +305,7 @@ python_api_name: qiskit.opflow.OperatorBase ### settings - + Return settings of this object in a dictionary. You can, for example, use this `settings` dictionary to serialize the object in JSON format, if the JSON encoder you use supports all types in the dictionary. @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -343,7 +343,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -361,7 +361,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -385,7 +385,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.mdx index fc5cfc40a0d..60b9f1971f2 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.mdx index 2cb80577e05..8d16ca30c39 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # qiskit.opflow\.converters.AbelianGrouper - + The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -53,7 +53,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.mdx index 6c516528c82..ec53600b780 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # qiskit.opflow\.converters.CircuitSampler - + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing. @@ -91,7 +91,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.mdx index 3af1f25823e..c7faf9f486a 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: 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. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.mdx index 210f9589af2..c2313b2a157 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # qiskit.opflow\.converters.DictToCircuitSum - + Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.mdx index a638866bee9..49ccffd393c 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # qiskit.opflow\.converters.PauliBasisChange - + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. The replacement function determines how the `PauliOps` should be replaced by their computed change-of-basis `CircuitOps` and destination `PauliOps`. Several convenient out-of-the-box replacement functions have been added as static methods, such as `measurement_replacement_fn`. @@ -106,7 +106,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### destination - + The destination `PauliOp`, or `None` if using the default destination, the diagonal basis. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.mdx index a9940ef7111..7f08174917b 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # qiskit.opflow\.converters.TwoQubitReduction - + Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.mdx index 5e5c5b8cb3d..9309f58aaf3 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # qiskit.opflow\.evolutions.EvolutionBase - + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.mdx index dc31befc812..512448557dc 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # qiskit.opflow\.evolutions.EvolutionFactory - + A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.mdx index 23a225b4d92..a749e1f2c14 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # qiskit.opflow\.evolutions.EvolvedOp - + Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -328,7 +328,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.mdx index b22af30e344..04a63b9418b 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: 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. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index ccac7d6f0fc..e70eef6cc15 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # qiskit.opflow\.evolutions.PauliTrotterEvolution - + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, evolve the Z by the desired evolution time with an rZ gate, and change the basis back using the adjoint of the original basis change circuit. For sums of Paulis, the individual Pauli evolution circuits are composed together by Trotterization scheme. @@ -100,7 +100,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.mdx index d14c123fa6c..6fb5de89ad7 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # qiskit.opflow\.evolutions.QDrift - + The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). **Parameters** @@ -60,7 +60,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.mdx index 975a997174a..7c147ccc500 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # qiskit.opflow\.evolutions.Suzuki - + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). @@ -65,7 +65,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### order - + returns order **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.mdx index 7562db06a16..e3b1b7117b6 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # qiskit.opflow\.evolutions.Trotter - + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### order - + returns order **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.mdx index c1cf629b3fc..4f4590613c3 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # qiskit.opflow\.evolutions.TrotterizationBase - + A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. ### \_\_init\_\_ @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### reps - + The number of repetitions to use in the Trotterization, improving the approximation accuracy. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.mdx index f9783ed2f76..55f47a05f9a 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # qiskit.opflow\.evolutions.TrotterizationFactory - + A factory for conveniently creating TrotterizationBase instances. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.mdx index 818473bf4db..a2b1664af75 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # qiskit.opflow\.expectations.AerPauliExpectation - + An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.mdx index eb163522c96..09c1e8b53f4 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # qiskit.opflow\.expectations.CVaRExpectation - + Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w\.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator of the energy. However in several problem settings with a diagonal Hamiltonian, e.g. in combinatorial optimization where the Hamiltonian encodes a cost function, we are not interested in calculating the energy but in the lowest possible value we can find. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.mdx index ff8a689976c..6335d4682b7 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # qiskit.opflow\.expectations.ExpectationBase - + A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.mdx index b318dbcb1b4..1392bef6f16 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # qiskit.opflow\.expectations.ExpectationFactory - + A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. ### \_\_init\_\_ @@ -26,7 +26,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.mdx index c124bfc5c37..e243101bc41 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # qiskit.opflow\.expectations.MatrixExpectation - + An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.mdx index 29bb6feba9e..bcbadc41afe 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # qiskit.opflow\.expectations.PauliExpectation - + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.mdx index ebb7aa13e9c..774406e9da0 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # qiskit.opflow\.gradients.CircuitGradient - + Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.mdx index 04831539b62..6b1cdf3a633 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # qiskit.opflow\.gradients.CircuitQFI - + Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor with respect to the given circuit parameters @@ -32,7 +32,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.mdx index 714e3a465bb..6791e10294a 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # qiskit.opflow\.gradients.DerivativeBase - + Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo\_fn’s and enforcing product rules when operator coefficients are parameterized. @@ -34,7 +34,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -77,7 +77,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.mdx index 6838b27c24d..afecc06598c 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # qiskit.opflow\.gradients.Gradient - + Convert an operator expression to the first-order gradient. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.opflow.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.mdx index a7e7007f341..752f3b9fdbd 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # qiskit.opflow\.gradients.GradientBase - + Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. @@ -52,7 +52,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.mdx index 828ec6698c1..c63e724a855 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # qiskit.opflow\.gradients.Hessian - + Compute the Hessian of an expected value. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.opflow.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.mdx index 5dc8eba6f13..2d1712227b9 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # qiskit.opflow\.gradients.HessianBase - + Base class for the Hessian of an expected value. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -93,7 +93,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### hess\_method - + Returns `CircuitGradient`. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.mdx index 2352ec920e6..d882d0d4d6b 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # qiskit.opflow\.gradients.NaturalGradient - + Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### grad\_method - + Returns `CircuitGradient`. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### qfi\_method - + Returns `CircuitQFI`. Returns: `CircuitQFI` @@ -148,7 +148,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### regularization - + Returns the regularization option. Returns: the regularization option. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.mdx index ca0bf746378..e9e94dea964 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # qiskit.opflow\.gradients.QFI - + Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parameterized quantum state, where QFI is: @@ -98,7 +98,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -117,7 +117,7 @@ $$ ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.mdx index 5a297cbcc62..e520f14ba91 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # qiskit.opflow\.gradients.QFIBase - + Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. @@ -54,7 +54,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -97,7 +97,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase ### qfi\_method - + Returns `CircuitQFI`. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.mdx index 2f86e53d50d..146df825a87 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # qiskit.opflow\.list\_ops.ComposedOp - + A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. **Parameters** @@ -78,7 +78,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -294,7 +294,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -370,7 +370,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -384,7 +384,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -464,7 +464,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.mdx index 4e713a61192..e4e6683cecc 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # qiskit.opflow\.list\_ops.ListOp - + A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. 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`. For example, a `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`’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` 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`. In this way, the `ListOps` are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -90,7 +90,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -306,7 +306,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -316,7 +316,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### instance\_id - + Return the unique instance id. **Return type** @@ -368,7 +368,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -382,7 +382,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -396,7 +396,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -462,7 +462,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.mdx index 63742eddd83..c4ffa130bbf 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # qiskit.opflow\.list\_ops.SummedOp - + A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. **Parameters** @@ -78,7 +78,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -236,7 +236,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** @@ -246,7 +246,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -328,7 +328,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -338,7 +338,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### instance\_id - + Return the unique instance id. **Return type** @@ -390,7 +390,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -404,7 +404,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -418,7 +418,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -486,7 +486,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.mdx index 48172d91250..47e39f0a86f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # qiskit.opflow\.list\_ops.TensoredOp - + A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. **Parameters** @@ -77,7 +77,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### abelian - + Whether the Operators in `oplist` are known to commute with one another. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### combo\_fn - + The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in `oplist`. **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### distributive - + Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv\[0] @ op + opv\[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### grad\_combo\_fn - + The gradient of `combo_fn`. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### instance\_id - + Return the unique instance id. **Return type** @@ -355,7 +355,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -369,7 +369,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** @@ -383,7 +383,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -449,7 +449,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.mdx index b4ee14dd315..5c9a7109e2d 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # qiskit.opflow\.primitive\_ops.CircuitOp - + Class for Operators backed by Terra’s `QuantumCircuit` module. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### instance\_id - + Return the unique instance id. **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -334,7 +334,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -376,7 +376,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.mdx index 084bf200125..4867ada8613 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # qiskit.opflow\.primitive\_ops.MatrixOp - + Class for Operators represented by matrices, backed by Terra’s `Operator` module. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### instance\_id - + Return the unique instance id. **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -338,7 +338,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -380,7 +380,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.mdx index 50e7b36c0bf..f368a6d4e7f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # qiskit.opflow\.primitive\_ops.PauliOp - + Class for Operators backed by Terra’s `Pauli` module. **Parameters** @@ -138,7 +138,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -236,7 +236,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### instance\_id - + Return the unique instance id. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -336,7 +336,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 935849ec074..9d0b08dd176 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # qiskit.opflow\.primitive\_ops.PauliSumOp - + Class for Operators backend by Terra’s `SparsePauliOp` class. **Parameters** @@ -145,7 +145,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -249,7 +249,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -268,7 +268,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -364,7 +364,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -378,7 +378,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -412,7 +412,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -459,7 +459,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index ba8e708d9f9..5b5a88d1906 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # qiskit.opflow\.primitive\_ops.PrimitiveOp - + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. Note that all mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. @@ -132,7 +132,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### instance\_id - + Return the unique instance id. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -296,7 +296,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -330,7 +330,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp ### settings - + Return operator settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index c73fba87c35..c139c9aa300 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # qiskit.opflow\.primitive\_ops.TaperedPauliSumOp - + Class for PauliSumOp after tapering **Parameters** @@ -146,7 +146,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### coeffs - + Return the Pauli coefficients. @@ -250,7 +250,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** @@ -269,7 +269,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### grouping\_type - + Type of Grouping **Type** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### instance\_id - + Return the unique instance id. **Return type** @@ -365,7 +365,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -379,7 +379,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -413,7 +413,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### primitive - + The primitive defining the underlying function of the Operator. **Return type** @@ -460,7 +460,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### settings - + Return operator settings. **Return type** @@ -592,7 +592,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp ### z2\_symmetries - + Z2 symmetries which the Operator has. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 4e760a6e3d8..18ddeeb1393 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # qiskit.opflow\.primitive\_ops.Z2Symmetries - + Z2 Symmetries **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### cliffords - + Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian. @@ -95,7 +95,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### settings - + Return operator settings. **Return type** @@ -125,19 +125,19 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### sq\_list - + returns sq list ### sq\_paulis - + returns sq paulis ### symmetries - + return symmetries @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### tapering\_values - + returns tapering values diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 3fd481a4552..761fbce4b00 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # qiskit.opflow\.state\_fns.CVaRMeasurement - + **A specialized measurement class to compute CVaR expectation values.** See [https://arxiv.org/pdf/1907.04769.pdf](https://arxiv.org/pdf/1907.04769.pdf) for further details. @@ -123,7 +123,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### alpha - + **A real-valued parameter between 0 and 1 which specifies the** fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half. @@ -167,7 +167,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### instance\_id - + Return the unique instance id. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -374,7 +374,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -430,7 +430,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -480,7 +480,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.mdx index 989d072b19a..36e4e811561 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # qiskit.opflow\.state\_fns.CircuitStateFn - + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. **Parameters** @@ -145,7 +145,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** @@ -263,7 +263,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -315,7 +315,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -415,7 +415,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.mdx index a21a1423462..d1084d7ff6d 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # qiskit.opflow\.state\_fns.DictStateFn - + A class for state functions and measurements which are defined by a lookup table, stored in a dict. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -234,7 +234,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -276,7 +276,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -290,7 +290,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -332,7 +332,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -386,7 +386,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.mdx index f5ec56a4ad6..9ce29a0d47f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # qiskit.opflow\.state\_fns.OperatorStateFn - + A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -279,7 +279,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -371,7 +371,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 434acd00075..4afdde3270f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # qiskit.opflow\.state\_fns.SparseVectorStateFn - + A class for sparse state functions and measurements in vector representation. This class uses `scipy.sparse.spmatrix` for the internal representation. @@ -144,7 +144,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -236,7 +236,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -334,7 +334,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -388,7 +388,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.mdx index cc11783fec7..50efb6f62ad 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # qiskit.opflow\.state\_fns.StateFn - + A class for representing state functions and measurements. 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. @@ -137,7 +137,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -285,7 +285,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -327,7 +327,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -381,7 +381,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.mdx index 1c31600cc19..f238c9f9d42 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # qiskit.opflow\.state\_fns.VectorStateFn - + A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### instance\_id - + Return the unique instance id. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -266,7 +266,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### num\_qubits - + The number of qubits over which the Operator is defined. If `op.num_qubits == 5`, then `op.eval('1' * 5)` will be valid, but `op.eval('11')` will not. **Return type** @@ -280,7 +280,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### parameters - + Return a set of Parameter objects contained in the Operator. @@ -322,7 +322,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### primitive - + The primitive which defines the behavior of the underlying State function. @@ -376,7 +376,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.mdx index 57f4848eb03..cf80f51af66 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.mdx index c6a662e3b43..a7214bb57c2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # qiskit.optimization.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 2a05542589f..fac5d6db3ec 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # qiskit.optimization.algorithms.ADMMOptimizationResult - + ADMMOptimization Result. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### state - + returns state **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -121,7 +121,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -135,7 +135,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.mdx index ce8fa022986..aab119a9138 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # qiskit.optimization.algorithms.ADMMOptimizer - + An implementation of the ADMM-based heuristic. This algorithm is introduced in \[1]. @@ -92,7 +92,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer ### parameters - + Returns current parameters of the optimizer. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.mdx index f0389705c6e..90db1cd91a2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # qiskit.optimization.algorithms.ADMMParameters - + Defines a set of parameters for ADMM optimizer. Defines parameters for ADMM optimizer and their default values. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.mdx index 4595f865b33..6614f4c70e0 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # qiskit.optimization.algorithms.ADMMState - + Internal computation state of the ADMM implementation. The state keeps track of various variables are stored that are being updated during problem solving. The values are relevant to the problem being solved. The state is recreated for each optimization problem. State is returned as the third value. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.mdx index 6e923b0ccd7..c004ba4e818 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # qiskit.optimization.algorithms.CobylaOptimizer - + The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.mdx index 706d15875e5..69931748b27 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # qiskit.optimization.algorithms.CplexOptimizer - + The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index e9ec74f18af..034e93e4f26 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # qiskit.optimization.algorithms.GroverOptimizationResult - + A result object for Grover Optimization methods. Constructs a result object with the specific Grover properties. @@ -69,7 +69,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### intermediate\_fval - + Getter of the intermediate fval **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_input\_qubits - + Getter of n\_input\_qubits **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### n\_output\_qubits - + Getter of n\_output\_qubits **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### operation\_counts - + Get the operation counts. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -155,7 +155,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -183,7 +183,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### threshold - + Getter of the threshold of Grover algorithm. **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -225,7 +225,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.mdx index 7805c09a8d5..c017b2493a5 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # qiskit.optimization.algorithms.GroverOptimizer - + Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer ### quantum\_instance - + The quantum instance to run the circuits. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.mdx index 6b7fed092a7..707027da784 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # qiskit.optimization.algorithms.IntermediateResult - + Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 5f41710e8c8..94a19c249b8 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # qiskit.optimization.algorithms.MinimumEigenOptimizationResult - + Minimum Eigen Optimizer Result. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### min\_eigen\_solver\_result - + Returns a result object obtained from the instance of `MinimumEigensolver`. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### raw\_samples - + Returns the list of raw solution samples of `MinimumEigensolver`. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -165,7 +165,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index ad5c27f7431..c85991d6206 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # qiskit.optimization.algorithms.MinimumEigenOptimizer - + A wrapper for minimum eigen solvers from Qiskit Aqua. This class provides a wrapper for minimum eigen solvers from Qiskit to be used within the optimization module. It assumes a problem consisting only of binary or integer variables as well as linear equality constraints thereof. It converts such a problem into a Quadratic Unconstrained Binary Optimization (QUBO) problem by expanding integer variables into binary variables and by adding the linear equality constraints as weighted penalty terms to the objective function. The resulting QUBO is then translated into an Ising Hamiltonian whose minimal eigen vector and corresponding eigenstate correspond to the optimal solution of the original optimization problem. The provided minimum eigen solver is then used to approximate the ground state of the Hamiltonian to find a good solution for the optimization problem. @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer ### min\_eigen\_solver - + Returns the minimum eigensolver. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 990cb906264..46f8728fbc6 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # qiskit.optimization.algorithms.MultiStartOptimizer - + An abstract class that implements multi start optimization and should be sub-classed by other optimizers. Constructs an instance of this optimizer. @@ -48,7 +48,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -62,7 +62,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. @@ -141,7 +141,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index be4e56a9955..7c401461d24 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # qiskit.optimization.algorithms.OptimizationAlgorithm - + An abstract class for optimization algorithms in Qiskit’s optimization module. ### \_\_init\_\_ @@ -28,7 +28,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -64,7 +64,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.mdx index ae2b033deed..8094132f7ed 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # qiskit.optimization.algorithms.OptimizationResult - + A base class for optimization results. The optimization algorithms return an object of the type `OptimizationResult` with the information about the solution obtained. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -156,7 +156,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -198,7 +198,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index a0eff974aad..3c3dc40eb73 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # qiskit.optimization.algorithms.OptimizationResultStatus - + Termination status of an optimization algorithm. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 759447cef02..674ed729cf0 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult - + Recursive Eigen Optimizer Result. Constructs an instance of the result class. @@ -60,7 +60,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### fval - + Returns the optimal function value. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### history - + Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### replacements - + Returns a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### samples - + Returns the list of solution samples **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -152,7 +152,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index af82acf3b40..3e8a9033c99 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer - + A meta-algorithm that applies a recursive optimization. The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index bbede36b2c3..eac72c40a44 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # qiskit.optimization.algorithms.SlsqpOptimizationResult - + SLSQP optimization result, defines additional properties that may be returned by the optimizer. Constructs a result object with properties specific to SLSQP. @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fval - + Returns the optimal function value. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### fx - + Returns the final value of the objective function being actually optimized. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### imode - + Returns the exit mode from the optimizer. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### its - + Returns the number of iterations **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### raw\_results - + Return the original results object from the optimization algorithm. Currently a dump for any leftovers. @@ -126,7 +126,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### samples - + Returns the list of solution samples **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### smode - + Returns message describing the exit mode from the optimizer. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### status - + Returns the termination status of the optimization algorithm. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variable\_names - + Returns the list of variable names of the optimization problem. **Return type** @@ -178,7 +178,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables - + Returns the list of variables of the optimization problem. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### variables\_dict - + Returns the optimal value as a dictionary of the variable name and corresponding value. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult ### x - + Returns the optimal value found in the optimization or None in case of FAILURE. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index e164c53a9ed..f7bc6a8894e 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # qiskit.optimization.algorithms.SlsqpOptimizer - + The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -98,7 +98,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### clip - + Returns the clip value for this optimizer. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer ### trials - + Returns the number of trials for this optimizer. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.mdx index 4396d597a6f..1c4fdf310cb 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # qiskit.optimization.algorithms.SolutionSample - + A sample of an optimization solution ### x diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx index 92d3d3d31f2..7eb8cf5d8d2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx @@ -32,12 +32,12 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp ### TspData - + Create new instance of TspData(name, dim, coord, w) #### coord - + Alias for field number 2 @@ -49,7 +49,7 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### dim - + Alias for field number 1 @@ -63,13 +63,13 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp #### name - + Alias for field number 0 #### w - + Alias for field number 3 diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.mdx index 773b2b14e50..aa541790e65 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # qiskit.optimization.converters.InequalityToEquality - + Convert inequality constraints into equality constraints by introducing slack variables. **Examples** @@ -112,7 +112,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality ### mode - + Returns the mode of the converter **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.mdx index 781285ebc33..a784e593b16 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # qiskit.optimization.converters.IntegerToBinary - + Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index 613aef79e7f..6b00cbc52a9 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # qiskit.optimization.converters.LinearEqualityToPenalty - + Convert a problem with only equality constraints to unconstrained with penalty terms. **Parameters** @@ -83,7 +83,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 8e9d417f504..f9144290aa3 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # qiskit.optimization.converters.QuadraticProgramConverter - + An abstract class for converters of quadratic programs in Qiskit’s optimization module. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index afbfbf0c222..654306d442b 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # qiskit.optimization.converters.QuadraticProgramToQubo - + Convert a given optimization problem to a new problem that is a QUBO. **Examples** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### penalty - + Returns the penalty factor used in conversion. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.mdx index cacfebafefa..198e25adc32 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # qiskit.optimization.problems.Constraint - + Abstract Constraint Class. Initializes the constraint. @@ -57,7 +57,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** @@ -75,7 +75,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.mdx index c6cade6be8f..8012335c854 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # qiskit.optimization.problems.LinearConstraint - + Representation of a linear constraint. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.mdx index 17f8b1b328d..b94cbc7d5eb 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # qiskit.optimization.problems.LinearExpression - + Representation of a linear expression by its coefficients. Creates a new linear expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.mdx index 51854c923bc..ff30982abce 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # qiskit.optimization.problems.QuadraticConstraint - + Representation of a quadratic constraint. Constructs a quadratic constraint, consisting of a linear and a quadratic term. @@ -81,7 +81,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -95,7 +95,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -151,7 +151,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.mdx index 6bf0a82b458..fb9d9b18740 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # qiskit.optimization.problems.QuadraticExpression - + Representation of a quadratic expression by its coefficients. Creates a new quadratic expression. @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -102,7 +102,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.mdx index ccd36875b0e..065d86bfc4d 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # qiskit.optimization.problems.QuadraticObjective - + Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. Constructs a quadratic objective function. @@ -61,7 +61,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -125,7 +125,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### sense - + Returns the sense of the objective function. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.mdx index 2b72e18387b..a0c1ca22a8e 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # qiskit.optimization.problems.QuadraticProgram - + Quadratically Constrained Quadratic Program representation. This representation supports inequality and equality constraints, as well as continuous, binary, and integer variables. @@ -605,7 +605,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -619,7 +619,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints\_index - + Returns the dictionary that maps the name of a linear constraint to its index. **Return type** @@ -673,7 +673,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -687,7 +687,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -749,7 +749,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -763,7 +763,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints\_index - + Returns the dictionary that maps the name of a quadratic constraint to its index. **Return type** @@ -838,7 +838,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -912,7 +912,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -926,7 +926,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables\_index - + Returns the dictionary that maps the name of a variable to its index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.mdx index fce41233579..2ed7c5c3895 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # qiskit.optimization.problems.QuadraticProgramElement - + Interface class for all objects that have a parent QuadraticProgram. Initialize object with parent QuadraticProgram. @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.mdx index 9b632a061b3..714b11e33fb 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # qiskit.optimization.problems.Variable - + Representation of a variable. Creates a new Variable. @@ -86,7 +86,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -142,7 +142,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.28/qiskit.providers.Backend.mdx index 27cf239d527..223941a9b69 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # qiskit.providers.Backend - + Base common type for all versioned Backend abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.mdx index 4c117f9d77a..264c6d2ea37 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.28/qiskit.providers.BackendV1.mdx index 2006198e7b7..9a68210d940 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # qiskit.providers.BackendV1 - + Abstract class for Backends This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.BackendV1 ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. @@ -129,7 +129,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.mdx index 053493a0962..0b9a3b0ed83 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # qiskit.providers.BaseBackend - + Legacy Base class for backends. DEPRECATED Legacy base class for backends. @@ -26,7 +26,7 @@ python_api_name: qiskit.providers.BaseBackend ### \_\_init\_\_ - + DEPRECATED Legacy base class for backends. This method should initialize the module and its configuration, and raise an exception if a component of the module is not available. @@ -112,7 +112,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.BaseJob.mdx index 3816b2c960e..4c7377ca8b4 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # qiskit.providers.BaseJob - + DEPRECATED Legacy Class to handle asynchronous jobs Initializes the asynchronous job. @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -104,7 +104,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -120,13 +120,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.mdx index 0092bf32301..0d76b48fbbb 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # qiskit.providers.BaseProvider - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.Job.mdx b/docs/api/qiskit/0.28/qiskit.providers.Job.mdx index 4ded804223a..31904b5f99f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # qiskit.providers.Job - + Base common type for all versioned Job abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.28/qiskit.providers.JobError.mdx index 8d6902d32c5..a293a061a60 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.28/qiskit.providers.JobStatus.mdx index dabe05bb004..db3a1a51550 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # qiskit.providers.JobStatus - + Class for job status enumerated type. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.mdx index d9c4eea4d55..f90065a023a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.28/qiskit.providers.JobV1.mdx index 2f01890c2e7..a1632a0c53b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # qiskit.providers.JobV1 - + Class to handle jobs This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. @@ -114,7 +114,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -130,13 +130,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.28/qiskit.providers.Options.mdx b/docs/api/qiskit/0.28/qiskit.providers.Options.mdx index 0803123d419..379c9331c3e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # qiskit.providers.Options - + Base options object This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. diff --git a/docs/api/qiskit/0.28/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.28/qiskit.providers.Provider.mdx index ad388eb3a6e..b92dd4e88cd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # qiskit.providers.Provider - + Base common type for all versioned Provider abstract classes. Note this class should not be inherited from directly, it is intended to be used for type checking. When implementing a provider you should use the versioned abstract classes as the parent class and not this class directly. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.mdx index a3e0b67ccf5..18dbf7c2f97 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # qiskit.providers.ProviderV1 - + Base class for a Backend Provider. ### \_\_init\_\_ @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.mdx index db38fd3a38c..35b07cec5bb 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.mdx index 5f19e6662bc..db6c76b8924 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.mdx index 7d436aa2dcd..276c34ed48b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # qiskit.providers.aer.AerJob - + AerJob class. ### \_executor diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.mdx index 4cc9bbc4687..c52b9c43fea 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # qiskit.providers.aer.AerProvider - + Provider for Qiskit Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.mdx index 894385f2b2c..5166e47fa6b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # qiskit.providers.aer.AerSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.mdx index df0ca228569..70031ecd02c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # qiskit.providers.aer.PulseSimulator - + Pulse schedule simulator backend. The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.mdx index 43e90230390..5eae2e7dda2 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # qiskit.providers.aer.QasmSimulator - + Noisy quantum circuit simulator backend. **Configurable Options** @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.mdx index 9eb2cb364c1..6baabe9c159 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # qiskit.providers.aer.StatevectorSimulator - + Ideal quantum circuit statevector simulator **Configurable Options** @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.mdx index a6675a75b9b..0868ccf5ad1 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # qiskit.providers.aer.UnitarySimulator - + Ideal quantum circuit unitary simulator. **Configurable Options** @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.mdx index db1f78574ed..045c4bdfdc3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # qiskit.providers.aer.extensions.Snapshot - + Simulator snapshot instruction. Create new snapshot instruction. @@ -134,25 +134,25 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### label - + Return snapshot label @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### params - + return instruction params. @@ -246,7 +246,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### snapshot\_type - + Return snapshot type @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 2c20eeb77ea..12b15b07e12 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # qiskit.providers.aer.extensions.SnapshotDensityMatrix - + Snapshot instruction for density matrix method of Qasm simulator. Create a density matrix state snapshot instruction. @@ -136,25 +136,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### label - + Return snapshot label @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### params - + return instruction params. @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### snapshot\_type - + Return snapshot type @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index 8b20ebc3bf2..3ff9d54af1c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # qiskit.providers.aer.extensions.SnapshotExpectationValue - + Snapshot instruction for supported methods of Qasm simulator. Create an expectation value snapshot instruction. @@ -140,25 +140,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### label - + Return snapshot label @@ -198,7 +198,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### snapshot\_type - + Return snapshot type @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index d4ca4722422..6ca254da637 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # qiskit.providers.aer.extensions.SnapshotProbabilities - + Snapshot instruction for all methods of Qasm simulator. Create a probability snapshot instruction. @@ -138,25 +138,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### label - + Return snapshot label @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### params - + return instruction params. @@ -250,7 +250,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### snapshot\_type - + Return snapshot type @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 17bbf008b12..3593e47867a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # qiskit.providers.aer.extensions.SnapshotStabilizer - + Snapshot instruction for stabilizer method of Qasm simulator. Create a stabilizer state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index bbbf00fd9ba..64b295051a9 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # qiskit.providers.aer.extensions.SnapshotStatevector - + Snapshot instruction for statevector snapshot type Create a statevector state snapshot instruction. @@ -144,25 +144,25 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### label - + Return snapshot label @@ -202,7 +202,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### snapshot\_type - + Return snapshot type @@ -280,7 +280,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.mdx index 1f33289d8ca..1289ab2dd44 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # qiskit.providers.aer.library.SaveAmplitudes - + Save complex statevector amplitudes. Instruction to save complex statevector amplitudes. @@ -132,19 +132,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -162,7 +162,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### label - + Return instruction label **Return type** @@ -188,7 +188,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### params - + return instruction params. @@ -260,7 +260,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index e7b2fbda9af..ea49f63204a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # qiskit.providers.aer.library.SaveAmplitudesSquared - + Save squared statevector amplitudes (probabilities). Instruction to save squared statevector amplitudes (probabilities). @@ -134,19 +134,19 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -164,7 +164,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### label - + Return instruction label **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### params - + return instruction params. @@ -262,7 +262,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 0e91eb4d04a..938756d46f9 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # qiskit.providers.aer.library.SaveDensityMatrix - + Save a reduced density matrix. Create new instruction to save the simulator reduced density matrix. @@ -124,19 +124,19 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.mdx index d75bfadab25..77e46ff68c0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # qiskit.providers.aer.library.SaveExpectationValue - + Save expectation value of an operator. Instruction to save the expectation value of a Hermitian operator. @@ -144,19 +144,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### label - + Return instruction label **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### params - + return instruction params. @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index a881f0f3b95..c72c0aebf2f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # qiskit.providers.aer.library.SaveExpectationValueVariance - + Save expectation value and variance of an operator. Instruction to save the expectation value and variance of a Hermitian operator. @@ -144,19 +144,19 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -174,7 +174,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### label - + Return instruction label **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### params - + return instruction params. @@ -272,7 +272,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.mdx index a9213df30ac..39fca57f768 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # qiskit.providers.aer.library.SaveMatrixProductState - + Save matrix product state instruction Create new instruction to save the matrix product state. @@ -130,19 +130,19 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### label - + Return instruction label **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### params - + return instruction params. @@ -258,7 +258,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.mdx index 6c5c6592c68..8c70130fa56 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # qiskit.providers.aer.library.SaveProbabilities - + Save measurement outcome probabilities vector. Instruction to save measurement probabilities vector. @@ -124,19 +124,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index 5eea6a2d426..3f6ab56605b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # qiskit.providers.aer.library.SaveProbabilitiesDict - + Save measurement outcome probabilities dict. Instruction to save measurement probabilities dict. @@ -124,19 +124,19 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -154,7 +154,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### label - + Return instruction label **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### params - + return instruction params. @@ -252,7 +252,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.mdx index e89700d2855..8530fddb22d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # qiskit.providers.aer.library.SaveStabilizer - + Save Stabilizer instruction Create new instruction to save the stabilizer simulator state. @@ -130,19 +130,19 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### label - + Return instruction label **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### params - + return instruction params. @@ -258,7 +258,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.mdx index d972fafe5a1..9123f554cac 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # qiskit.providers.aer.library.SaveState - + Save simulator state The format of the saved state depends on the simulation method used. @@ -136,19 +136,19 @@ python_api_name: qiskit.providers.aer.library.SaveState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -166,7 +166,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### label - + Return instruction label **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### params - + return instruction params. @@ -264,7 +264,7 @@ python_api_name: qiskit.providers.aer.library.SaveState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.mdx index d3c5bb55d21..383466ccced 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # qiskit.providers.aer.library.SaveStatevector - + Save statevector Create new instruction to save the simulator statevector. @@ -130,19 +130,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### label - + Return instruction label **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### params - + return instruction params. @@ -258,7 +258,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.mdx index acbf1d552e3..170ee4f92ef 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # qiskit.providers.aer.library.SaveStatevectorDict - + Save statevector as ket-form dictionary. Create new instruction to save the simulator statevector as a dict. @@ -130,19 +130,19 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### label - + Return instruction label **Return type** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### params - + return instruction params. @@ -258,7 +258,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.mdx index 0804d21c355..63485129064 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # qiskit.providers.aer.library.SaveSuperOp - + Save a SuperOp matrix. Create new instruction to save the superop simulator state. @@ -128,19 +128,19 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -158,7 +158,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### label - + Return instruction label **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.mdx index 386139f94af..ec5f40bd2e9 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # qiskit.providers.aer.library.SaveUnitary - + Save Unitary Create new instruction to save the unitary simulator state. @@ -128,19 +128,19 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -158,7 +158,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### label - + Return instruction label **Return type** @@ -184,7 +184,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### params - + return instruction params. @@ -256,7 +256,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.mdx index 7ac2d185db0..85705a647f5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # qiskit.providers.aer.library.SetDensityMatrix - + Set density matrix state of the simulator Create new instruction to set the density matrix state of the simulator. @@ -132,19 +132,19 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### label - + Return instruction label **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### params - + return instruction params. @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.mdx index 5179fb6b1ce..1e26b018f5a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # qiskit.providers.aer.library.SetMatrixProductState - + Set the matrix product state of the simulator Create new instruction to set the matrix product state of the simulator. @@ -124,19 +124,19 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### label - + Return instruction label **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### params - + return instruction params. @@ -268,7 +268,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.mdx index d953e71e111..647975281c7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # qiskit.providers.aer.library.SetStabilizer - + Set the Clifford stabilizer state of the simulator Create new instruction to set the Clifford stabilizer state of the simulator. @@ -124,19 +124,19 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### label - + Return instruction label **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### params - + return instruction params. @@ -268,7 +268,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.mdx index 92cfd7f2691..f8421913388 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # qiskit.providers.aer.library.SetStatevector - + Set the statevector state of the simulator Create new instruction to set the statevector state of the simulator. @@ -132,19 +132,19 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### label - + Return instruction label **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### params - + return instruction params. @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.mdx index 2147f572658..d6b9a68ea09 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # qiskit.providers.aer.library.SetSuperOp - + Set superop state of the simulator Create new instruction to set the superop simulator state. @@ -132,19 +132,19 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### label - + Return instruction label **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### params - + return instruction params. @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.mdx index 0c942d682ae..fd5e9f0f032 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # qiskit.providers.aer.library.SetUnitary - + Set unitary state of the simulator Create new instruction to set the unitary simulator state. @@ -132,19 +132,19 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### decompositions - + Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition - + Return definition in terms of other basic gates. ### duration - + Get the duration. @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### label - + Return instruction label **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### params - + return instruction params. @@ -276,7 +276,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary ### unit - + Get the time unit of duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.mdx index 0dc4d932729..34f9b3eb09b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # qiskit.providers.aer.noise.NoiseModel - + Noise model class for Qiskit Aer simulators. This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. @@ -211,13 +211,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### basis\_gates - + Return basis\_gates for compiling to the noise model. ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -279,7 +279,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** @@ -307,13 +307,13 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### noise\_instructions - + Return the set of noisy instructions for this noise model. ### noise\_qubits - + Return the set of noisy qubits for this noise model. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.mdx index 74b55875e7f..baf24e9adea 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # qiskit.providers.aer.noise.QuantumError - + Quantum error class for Qiskit Aer noise model **WARNING: The init interface for this class is not finalized and may** @@ -113,13 +113,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### atol - + The default absolute tolerance parameter for float comparisons. ### circuits - + Return the list of error circuits. @@ -231,7 +231,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -259,31 +259,31 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### probabilities - + Return the list of error probabilities. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. ### size - + Return the number of error circuit. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.mdx index 5ade73205a5..c80abb84bb6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # qiskit.providers.aer.noise.ReadoutError - + Readout error class for Qiskit Aer noise model. Create a readout error for a noise model. @@ -105,7 +105,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### atol - + The default absolute tolerance parameter for float comparisons. @@ -194,7 +194,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### number\_of\_qubits - + Return the number of qubits for the error. @@ -222,25 +222,25 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### probabilities - + Return the readout error probabilities matrix. ### rtol - + The relative tolerance parameter for float comparisons. ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 36fd9160769..2bbe1550693 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # qiskit.providers.aer.pulse.PulseSystemModel - + Physical model object for pulse simulator. This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -132,7 +132,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.mdx index 614c2a792a2..0fa61f4fa8b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # qiskit.providers.aer.utils.NoiseTransformer - + Transforms one quantum channel to another based on a specified criteria. ### \_\_init\_\_ @@ -74,7 +74,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -107,13 +107,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -188,7 +188,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -270,7 +270,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.mdx index 8d4928ed675..a8da3278b0a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.mdx index 1a68b416dae..d20a0bfd6a3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # qiskit.providers.basicaer.BasicAerJob - + BasicAerJob class. Initializes the asynchronous job. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.mdx index b508fe12721..3b8525e9cdc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # qiskit.providers.basicaer.BasicAerProvider - + Provider for Basic Aer backends. ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.mdx index bf6a82d03e4..e2e266e6033 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # qiskit.providers.basicaer.QasmSimulatorPy - + Python implementation of a qasm simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index a5e4649a511..720b9b7abfe 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # qiskit.providers.basicaer.StatevectorSimulatorPy - + Python statevector simulator. Initialize a backend class @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 285a805408b..458f76a9b28 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # qiskit.providers.basicaer.UnitarySimulatorPy - + Python implementation of a unitary simulator. Initialize a backend class @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.mdx index 0be40fad0b1..90718141baf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # qiskit.providers.ibmq.AccountProvider - + Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### backend - + Return the backend service. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### experiment - + Return the experiment service. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### random - + Return the random number service. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider ### runtime - + Return the runtime service. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.mdx index 6c019981cd3..333d2780e1b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # qiskit.providers.ibmq.BackendJobLimit - + Job limit for a backend. Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 28e4d975589..f0e114dddd0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 8d4576ef636..9b6854b092f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 0b6f8395607..dd02cd5f71f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 18fd46c4776..9d6b2391e7d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.mdx index 241768b12fa..ab6c06ef860 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 40c05724ec4..a4d713bc91b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.mdx index 46bdc36fba4..c297ba57692 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # qiskit.providers.ibmq.IBMQBackend - + Backend class interfacing with an IBM Quantum Experience device. You can run experiments on a backend using the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: @@ -267,7 +267,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.mdx index bf0e95ee4bf..c86107bcfa0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 6f196f6ecef..1c8abdc2522 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.mdx index 76ece262a69..e4c99d0a821 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.mdx index 2d8392f0085..6ab3e33fffc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # qiskit.providers.ibmq.IBMQBackendService - + Backend namespace for an IBM Quantum Experience account provider. Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 199eb2e5fa9..82698743406 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.mdx index a6a228a9cd0..dafe5bc208a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.mdx index d6fda756c5d..f3989b20995 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # qiskit.providers.ibmq.IBMQFactory - + Factory and account manager for IBM Quantum Experience. IBMQFactory constructor. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -190,7 +190,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.mdx index 06c453c06b6..5048bcefe99 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.mdx index 6953aa199b7..b20028f1057 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # qiskit.providers.ibmq.RunnerResult - + Result class for Qiskit Runtime program circuit-runner. ### \_\_init\_\_ @@ -66,7 +66,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -76,7 +76,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.mdx index 817ff8310b1..16700cc7b2b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # qiskit.providers.ibmq.credentials.Credentials - + IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 5c42a6e363d..7eb750a4284 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 05d5c3c1a9a..93cabc28694 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index e8106ee7abc..d94a9838e8e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.mdx index 3f4caef85db..0911a16f563 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult # qiskit.providers.ibmq.experiment.AnalysisResult - + Class representing an analysis result for an experiment. AnalysisResult constructor. @@ -72,7 +72,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### quality - + Return the analysis result quality. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -134,7 +134,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult ### uuid - + Return UUID of this analysis result. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.mdx index 48ff9731479..9f68932d817 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment # qiskit.providers.ibmq.experiment.Experiment - + Class representing an experiment. Experiment constructor. @@ -140,7 +140,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### analysis\_results - + Return analysis results associated with this experiment. **Return type** @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### backend\_name - + Return the experiment’s backend name. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### creation\_datetime - + Return the timestamp when the experiment was created. **Return type** @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### end\_datetime - + Return the timestamp when the experiment ended. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### from\_remote\_data - + Create an instance of this class from remote data. **Parameters** @@ -199,7 +199,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### group - + Return the experiment’s group. **Return type** @@ -209,7 +209,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### hub - + Return the experiment’s hub. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### owner - + Return the experiment’s owner. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### plot\_names - + Return names of plots associated with this experiment. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### project - + Return the experiment’s project. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### share\_level - + Return the experiment share\_level. **Return type** @@ -269,7 +269,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### start\_datetime - + Return the timestamp when the experiment started. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### updated\_datetime - + Return the timestamp when the experiment was last updated. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment ### uuid - + Return the experiment’s uuid. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.mdx index 84916a05740..4258c1a7c81 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService # qiskit.providers.ibmq.experiment.ExperimentService - + Provides experiment related services. This class is the main interface to invoke IBM Quantum Experience experiment services, which allow you to create, delete, update, query, and retrieve experiments, experiment plots, and analysis results. The `experiment` attribute of `AccountProvider` is an instance of this class, and the main syntax for using the services is `provider.experiment.`. For example: diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.mdx index 6c4839a0ed2..646e5a030b7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # qiskit.providers.ibmq.job.IBMQJob - + Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. @@ -210,7 +210,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -264,7 +264,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob ### experiment\_id - + Return the experiment ID. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 641561aa480..39817dbbfda 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.mdx index 6764564dedc..b31e6fc1823 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 9e6874f0223..a9e61132a8f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 766c5411270..361c91a6b75 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 2be7ab82de5..98618bd8e3f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.mdx index f9ce0d0f850..ec3f8a71ad5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # qiskit.providers.ibmq.job.QueueInfo - + Queue information for a job. QueueInfo constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 0f3b2c3eda5..336b0638370 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # qiskit.providers.ibmq.managed.IBMQJobManager - + Job Manager for IBM Quantum Experience. The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index d22b13e2533..3eb56ef8c45 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index ddf3b66a0ea..96becd5ace6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 16be2bf1296..4467e4b9830 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index b55d54e7907..d29bba86b92 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 10c0c77ee72..a99edf4c181 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index c6dffd8d418..d6d8c55cc23 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.mdx index e6861aaa5b4..8ae0ffe4d7c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # qiskit.providers.ibmq.managed.ManagedJob - + Job managed by the Job Manager. ManagedJob constructor. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 8467526241b..1cdcc14894e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # qiskit.providers.ibmq.managed.ManagedJobSet - + A set of managed jobs. An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.mdx index 2dff1d464e6..99c8fe3b804 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # qiskit.providers.ibmq.managed.ManagedResults - + Results managed by the Job Manager. This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.mdx index 39d8564bfe3..32b4ebde429 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # qiskit.providers.ibmq.random.CQCExtractor - + Class for interfacing with a CQC remote extractor. There are two extractor methods - Dodis (extractor 1) and Hayashi (extractor 2). These methods can be invoked synchronously or asynchronously. To invoke them synchronously: diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index a4b987ac967..dae4b0c49c0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # qiskit.providers.ibmq.random.CQCExtractorJob - + Representation of an asynchronous call to the CQC extractor. An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### extractor\_method - + Return the extractor method used. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob ### parameters - + Return the parameters passed to the extractor. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.mdx index e81cfaa1030..cc6edb29f48 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # qiskit.providers.ibmq.random.IBMQRandomService - + Random number services for an IBM Quantum Experience account provider. Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 402fdf8db20..11f24f34795 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # qiskit.providers.ibmq.runtime.IBMRuntimeService - + Class for interacting with the Qiskit Runtime service. Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index d7a8ab6ffac..663bd41098f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # qiskit.providers.ibmq.runtime.ParameterNamespace - + A namespace for program parameters with validation. This class provides a namespace for program parameters with auto-completion and validation support. @@ -44,7 +44,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace ### metadata - + Returns the parameter metadata **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index 31333587017..027119d63dd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # qiskit.providers.ibmq.runtime.ProgramBackend - + Base class for a program backend. This is a [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### options - + Return the options for the backend The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method. @@ -127,7 +127,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index c483ce684a3..17be75b58c0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # qiskit.providers.ibmq.runtime.ResultDecoder - + Runtime job result decoder. You can subclass this class and overwrite the [`decode()`](#qiskit.providers.ibmq.runtime.ResultDecoder.decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") method to create a custom result decoder for the results of your runtime program. For example: @@ -39,7 +39,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index 79d55a20594..0595eac9c75 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # qiskit.providers.ibmq.runtime.RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 45e297a6742..ef8bcfbb7c3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # qiskit.providers.ibmq.runtime.RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 43940e15846..0a2cbefd37e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # qiskit.providers.ibmq.runtime.RuntimeJob - + Representation of a runtime program execution. A new `RuntimeJob` instance is returned when you call [`IBMRuntimeService.run`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") to execute a runtime program, or [`IBMRuntimeService.job`](qiskit.providers.ibmq.runtime.IBMRuntimeService#job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") to retrieve a previously executed job. @@ -126,7 +126,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### creation\_date - + Job creation date in local time. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### inputs - + Job input parameters. **Return type** @@ -204,7 +204,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob ### program\_id - + Program ID. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 21cdedcbe9b..7d55031fbcd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # qiskit.providers.ibmq.runtime.RuntimeProgram - + Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### backend\_requirements - + Backend requirements. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### creation\_date - + Program creation date. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### description - + Program description. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### interim\_results - + Program interim result definitions. **Return type** @@ -145,7 +145,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### is\_public - + Whether the program is visible to all. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### max\_execution\_time - + Maximum execution time in seconds. A program execution exceeding this time will be forcibly terminated. @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### name - + Program name. **Return type** @@ -207,7 +207,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### program\_id - + Program ID. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### return\_values - + Program return value definitions. **Return type** @@ -249,7 +249,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram ### version - + Program version. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.mdx index dcf75dbbe31..f460bd7fbd5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # qiskit.providers.ibmq.runtime.UserMessenger - + Base class for handling communication with program users. This class can be used when writing a new Qiskit Runtime program. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.mdx index ae09bf4176a..5dc570de484 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # qiskit.providers.models.BackendConfiguration - + Backwards compat shim representing an abstract backend configuration. Initialize a QasmBackendConfiguration Object @@ -175,7 +175,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.mdx index 4ed024271d9..1f7a6c4866a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # qiskit.providers.models.BackendProperties - + Class representing backend properties This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.mdx index 6ef76f3ab8c..723ad7f238c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # qiskit.providers.models.BackendStatus - + Class representing Backend Status. Initialize a BackendStatus object @@ -53,7 +53,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.Command.mdx index f6391995495..2c45588dcde 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # qiskit.providers.models.Command - + Class representing a Command. ### name @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.mdx index 84417e4249e..e6a6a950b76 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # qiskit.providers.models.GateConfig - + Class representing a Gate Configuration ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.mdx index 784d9cd9128..4b877df18c1 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # qiskit.providers.models.JobStatus - + Model for JobStatus. ### job\_id @@ -57,7 +57,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.mdx index 09c058a75bc..f71a616d550 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # qiskit.providers.models.PulseBackendConfiguration - + Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. Initialize a backend configuration that contains all the extra configuration that is made available for OpenPulse backends. @@ -169,7 +169,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### control\_channels - + Return the control channels **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -305,7 +305,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. @@ -313,7 +313,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### sample\_rate - + Sample rate of the signal channels in Hz (1/dt). **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.mdx index 3b4d63f4a27..d2eef26bc3b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # qiskit.providers.models.PulseDefaults - + Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_est: `List`\[`float`] :param qubit\_freq\_est: Estimated qubit frequencies in GHz. :type meas\_freq\_est: `List`\[`float`] :param meas\_freq\_est: Estimated measurement cavity frequencies in GHz. :type buffer: `int` :param buffer: Default buffer time (in units of dt) between pulses. :type pulse\_library: `List`\[`PulseLibraryItem`] :param pulse\_library: Pulse name and sample definitions. :type cmd\_def: `List`\[`Command`] :param cmd\_def: Operation name and definition in terms of Commands. :type meas\_kernel: `Optional`\[`MeasurementKernel`] :param meas\_kernel: The measurement kernels :type discriminator: `Optional`\[`Discriminator`] :param discriminator: The discriminators :param \*\*kwargs: Other attributes for the super class. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.mdx index 196a8bb1332..310e21c75a7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # qiskit.providers.models.QasmBackendConfiguration - + Class representing a Qasm Backend Configuration. ### backend\_name @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### num\_qubits - + Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.mdx index 2af15960105..06ed9cd0b61 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # qiskit.providers.models.UchannelLO - + Class representing a U Channel LO ### q @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.mdx index 702e6d3ce11..e835fe3aadd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # qiskit.pulse.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.mdx index baa754a5dfc..622247ab2e8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # qiskit.pulse.AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Call.mdx index c1ce861b256..9e519a9f9a5 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # qiskit.pulse.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Constant.mdx index 08a11eb0652..c0a2338519d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # qiskit.pulse.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -59,7 +59,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -155,7 +155,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -175,7 +175,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.mdx index 7c701f7f094..9b91e41e217 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # qiskit.pulse.ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.ControlChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.ControlChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.ControlChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Delay.mdx index a9ff8c7ae41..ed2017e177c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # qiskit.pulse.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Drag.mdx index 8f78ceb72c0..3083a7836c6 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # qiskit.pulse.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -77,7 +77,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -115,7 +115,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -183,7 +183,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -203,7 +203,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -213,7 +213,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.mdx index cef9afa243d..5d5b0e86882 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # qiskit.pulse.DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.DriveChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.DriveChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.DriveChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.mdx index d34197e4a8a..32a3d853d83 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # qiskit.pulse.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -61,7 +61,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -157,7 +157,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -177,7 +177,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -187,7 +187,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.mdx index 886b3b91e50..3a9dda9fbe7 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # qiskit.pulse.GaussianSquare - + **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** or width parameter has to be specified. @@ -83,7 +83,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -179,7 +179,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -199,7 +199,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -209,7 +209,7 @@ $$ ### risefall\_sigma\_ratio - + The duration of each risefall in terms of sigma. **Return type** @@ -219,7 +219,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -243,7 +243,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.mdx index 3e867016aca..236e4d05fbf 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # qiskit.pulse.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.mdx index fa73fa1e3c9..b10e563a998 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: 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: ```python @@ -155,7 +155,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap ### instructions - + Return all instructions which have definitions. By default, these are typically the basis gates along with other instructions such as measure and reset. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.mdx index c1004283b40..43686b72ba9 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # qiskit.pulse.MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.mdx index ebefe276db5..ab1cd7c7ed8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # qiskit.pulse.MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.MemorySlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.MemorySlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.MemorySlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Play.mdx index 08a84570e83..982b2a04a20 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # qiskit.pulse.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.28/qiskit.pulse.PulseError.mdx index 4aa628018de..5a414811928 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.mdx index b7007c2a926..6b98391265e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # qiskit.pulse.RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.mdx index 653d9275122..871be683679 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # qiskit.pulse.Schedule - + A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. Pulse program representation for the original Qiskit Pulse model \[1]. Instructions are not allowed to overlap in time on the same channel. This overlap constraint is immediately evaluated when a new instruction is added to the `Schedule` object. @@ -200,7 +200,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -210,7 +210,7 @@ $$ ### children - + Return the child schedule components of this `Schedule` in the order they were added to the schedule. **Notes** @@ -300,7 +300,7 @@ $$ ### duration - + Duration of this schedule. **Return type** @@ -384,7 +384,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** @@ -424,7 +424,7 @@ $$ ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -444,7 +444,7 @@ $$ ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -456,7 +456,7 @@ $$ ### name - + Name of this Schedule **Return type** @@ -466,7 +466,7 @@ $$ ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -551,7 +551,7 @@ $$ ### start\_time - + Starting time of this schedule. **Return type** @@ -561,7 +561,7 @@ $$ ### stop\_time - + Stopping time of this schedule. **Return type** @@ -571,7 +571,7 @@ $$ ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.mdx index 9a2c9b0c85d..5c1ce290487 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # qiskit.pulse.ScheduleBlock - + A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. `ScheduleBlock` s should be initialized with one of the following alignment contexts: @@ -109,7 +109,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### alignment\_context - + Return alignment instance that allocates block component to generate schedule. @@ -158,7 +158,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### blocks - + Get the time-ordered instructions from self. **Return type** @@ -210,7 +210,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### channels - + Returns channels that this schedule clock uses. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### duration - + Duration of this schedule block. **Return type** @@ -382,7 +382,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** @@ -426,7 +426,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### instructions - + Get the time-ordered instructions from self. **Return type** @@ -456,7 +456,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### metadata - + The user provided metadata associated with the schedule. User provided `dict` of metadata for the schedule. The metadata contents do not affect the semantics of the program but are used to influence the execution of the schedule. It is expected to be passed between all transforms of the schedule and that providers will associate any schedule metadata with the results it returns from the execution of that schedule. @@ -468,7 +468,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### name - + Name of this Schedule **Return type** @@ -478,7 +478,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### parameters - + Parameters which determine the schedule behavior. **Return type** @@ -528,7 +528,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### start\_time - + Starting time of this schedule block. **Return type** @@ -538,7 +538,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### stop\_time - + Stopping time of this schedule block. **Return type** @@ -548,7 +548,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.mdx index 6015c0999f6..79792415b6d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # qiskit.pulse.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.mdx index 65503eaa60d..fa977b6cc0c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # qiskit.pulse.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.mdx index a8fd60509da..b0719b226b3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # qiskit.pulse.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.mdx index f95c068ef4b..f2a393d3804 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # qiskit.pulse.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.mdx index f35f3091824..34f3e6a37a3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # qiskit.pulse.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.28/qiskit.pulse.Waveform.mdx index 3ab52e6bcda..d90c7088724 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # qiskit.pulse.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.pulse.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.28/qiskit.pulse.channels.mdx index 310982e986c..9c7ad8f188a 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.channels.mdx @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### AcquireChannel - + Acquire channels are used to collect data. Channel class. @@ -68,7 +68,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -88,7 +88,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -98,7 +98,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -109,7 +109,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -147,7 +147,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -167,7 +167,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -177,7 +177,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -194,7 +194,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### ControlChannel - + Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. Channel class. @@ -228,7 +228,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -248,7 +248,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -258,7 +258,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -269,7 +269,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### DriveChannel - + Drive channels transmit signals to qubits which enact gate operations. Channel class. @@ -303,7 +303,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -323,7 +323,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -333,7 +333,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -344,7 +344,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MeasureChannel - + Measure channels transmit measurement stimulus pulses for readout. Channel class. @@ -378,7 +378,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -398,7 +398,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -408,7 +408,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -419,7 +419,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### MemorySlot - + Memory slot channels represent classical memory storage. Channel class. @@ -453,7 +453,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -473,7 +473,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -483,7 +483,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -494,7 +494,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### PulseChannel - + Base class of transmit Channels. Pulses can be played on these channels. Channel class. @@ -528,7 +528,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -548,7 +548,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -558,7 +558,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -569,7 +569,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### RegisterSlot - + Classical resister slot channels represent classical registers (low-latency classical memory). Channel class. @@ -603,7 +603,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -623,7 +623,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -633,7 +633,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** @@ -644,7 +644,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s ### SnapshotChannel - + Snapshot channels are used to specify instructions for simulators. Create new snapshot channel. @@ -674,7 +674,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### index - + Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, `DriveChannel(0)` labels the signal line driving the qubit labeled with index 0. **Return type** @@ -694,7 +694,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### name - + Return the shorthand alias for this channel, which is based on its type and index. **Return type** @@ -704,7 +704,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s #### parameters - + Parameters which determine the channel index. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.mdx index 6eba4189d79..1e31ff777b2 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # qiskit.pulse.instructions.Acquire - + The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: > * the number of cycles during which to acquire (in terms of dt), @@ -91,7 +91,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -180,7 +180,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns the channels that this schedule uses. **Return type** @@ -200,7 +200,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -289,7 +289,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -309,7 +309,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -319,7 +319,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -329,7 +329,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -339,7 +339,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -349,7 +349,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -359,7 +359,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slot - + The fast-access register slot which will store the classified readout result for fast-feedback computation. **Return type** @@ -388,7 +388,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -398,7 +398,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.mdx index 6aaa5d132d5..bb9de781101 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # qiskit.pulse.instructions.Call - + Pulse `Call` instruction. The `Call` instruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported). @@ -104,7 +104,7 @@ python_api_name: qiskit.pulse.instructions.Call ### arguments - + Parameters dictionary to be assigned to subroutine. **Return type** @@ -194,7 +194,7 @@ python_api_name: qiskit.pulse.instructions.Call ### channels - + Returns the channels that this schedule uses. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.pulse.instructions.Call ### duration - + Duration of this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Call ### id - + Unique identifier for this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Call ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Call ### name - + Name of this instruction. **Return type** @@ -313,7 +313,7 @@ python_api_name: qiskit.pulse.instructions.Call ### operands - + Return instruction operands. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.pulse.instructions.Call ### parameters - + Unassigned parameters which determine the instruction behavior. **Return type** @@ -352,7 +352,7 @@ python_api_name: qiskit.pulse.instructions.Call ### start\_time - + Relative begin time of this instruction. **Return type** @@ -362,7 +362,7 @@ python_api_name: qiskit.pulse.instructions.Call ### stop\_time - + Relative end time of this instruction. **Return type** @@ -372,7 +372,7 @@ python_api_name: qiskit.pulse.instructions.Call ### subroutine - + Return attached subroutine. **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.mdx index eb366167ade..bb9ed0912d7 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # qiskit.pulse.instructions.Delay - + A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. **Example** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns the channels that this schedule uses. **Return type** @@ -208,7 +208,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -228,7 +228,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -258,7 +258,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -278,7 +278,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -288,7 +288,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -298,7 +298,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -327,7 +327,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.mdx index b4338421f87..3eb1e8cdcdd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # qiskit.pulse.instructions.Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -243,7 +243,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -312,7 +312,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.mdx index 685474c29e9..151f2f6840c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # qiskit.pulse.instructions.Play - + This instruction is responsible for applying a pulse on a channel. The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend. @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.Play ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.mdx index 5a3bb2047d2..f3c2bed4d7a 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # qiskit.pulse.instructions.SetFrequency - + Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form $$ @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -231,7 +231,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -261,7 +261,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -281,7 +281,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -291,7 +291,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -301,7 +301,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.mdx index 2d5b7e7461c..f74b429c27c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # qiskit.pulse.instructions.SetPhase - + The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. In particular, a PulseChannel creates pulses of the form @@ -152,7 +152,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -162,7 +162,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -201,7 +201,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -221,7 +221,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -251,7 +251,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -271,7 +271,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -281,7 +281,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -291,7 +291,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -301,7 +301,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -330,7 +330,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -340,7 +340,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.mdx index c78777a9a68..3363097ee92 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # qiskit.pulse.instructions.ShiftFrequency - + Shift the channel frequency away from the current frequency. Creates a new shift frequency instruction. @@ -144,7 +144,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -154,7 +154,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### channels - + Returns the channels that this schedule uses. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### duration - + Duration of this instruction. **Return type** @@ -213,7 +213,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### frequency - + Frequency shift from the set frequency. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### start\_time - + Relative begin time of this instruction. **Return type** @@ -332,7 +332,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.mdx index a5cc85aa11f..4bc322d3475 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # qiskit.pulse.instructions.ShiftPhase - + The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -154,7 +154,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -164,7 +164,7 @@ $$ ### channels - + Returns the channels that this schedule uses. **Return type** @@ -203,7 +203,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -223,7 +223,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -253,7 +253,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -273,7 +273,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -283,7 +283,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -293,7 +293,7 @@ $$ ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -303,7 +303,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -332,7 +332,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -342,7 +342,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.mdx index 12b8789983e..c324bb9fe39 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # qiskit.pulse.instructions.Snapshot - + An instruction targeted for simulators, to capture a moment in the simulation. Create new snapshot. @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns the channels that this schedule uses. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -222,7 +222,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -272,7 +272,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -282,7 +282,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -292,7 +292,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -302,7 +302,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### parameters - + Parameters which determine the instruction behavior. **Return type** @@ -331,7 +331,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.mdx index e0094d8ffcd..5330d4ad29e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # qiskit.pulse.library.Constant - + A simple constant pulse, with an amplitude value and a duration: $$ @@ -59,7 +59,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -155,7 +155,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -175,7 +175,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.mdx index 47c7fa06aad..66a214d3f9c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # qiskit.pulse.library.Drag - + The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ @@ -77,7 +77,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -115,7 +115,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -183,7 +183,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -203,7 +203,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -213,7 +213,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.mdx index b1be189fdec..4d01818cbcd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # qiskit.pulse.library.Gaussian - + A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ @@ -61,7 +61,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -157,7 +157,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -177,7 +177,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -187,7 +187,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.mdx index e124ceafc25..0a553b0aac8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # qiskit.pulse.library.GaussianSquare - + **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** or width parameter has to be specified. @@ -83,7 +83,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -179,7 +179,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -199,7 +199,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -209,7 +209,7 @@ $$ ### risefall\_sigma\_ratio - + The duration of each risefall in terms of sigma. **Return type** @@ -219,7 +219,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -243,7 +243,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.mdx index 6f5abb7ef78..f7c7c00f8e3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # qiskit.pulse.library.Waveform - + A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. Create new sample pulse command. @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.library.Waveform ### id - + Unique identifier for this pulse. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.library.Waveform ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.pulse.library.Waveform ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.mdx index acb57ea93a9..aaeea160e88 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # qiskit.qasm.OpenQASMLexer - + A pygments lexer for OpenQasm. ### \_\_init\_\_ @@ -49,7 +49,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.28/qiskit.qasm.Qasm.mdx index 8881c5a94de..c4d53a4ea74 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.28/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # qiskit.qasm.Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.28/qiskit.qasm.QasmError.mdx index 04d563845f6..2334b09970e 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.mdx index c51b69285cb..1a81aed38e9 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # qiskit.qasm.QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.mdx index b42dafc5689..7cab6486142 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # qiskit.qasm.QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.mdx index 71b1a6f3910..40508eb0260 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # qiskit.qobj.GateCalibration - + Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. Initialize a single gate calibration. Instructions may reference waveforms which should be made available in the pulse\_library. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.mdx index 3744bab6c72..a1bf69cf675 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # qiskit.qobj.PulseLibraryItem - + An item in a pulse library. Instantiate a pulse library item. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.mdx index fdaac439213..bee20c71cd4 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # qiskit.qobj.PulseQobj - + A Pulse Qobj. Instantiate a new Pulse Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.mdx index 5e3dfbbddae..db5ecc3f06a 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # qiskit.qobj.PulseQobjConfig - + A configuration for a Pulse Qobj. Instantiate a PulseQobjConfig object. @@ -61,7 +61,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.mdx index 8993c613efd..56cfa3d0c75 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # qiskit.qobj.PulseQobjExperiment - + A Pulse Qobj Experiment. Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.mdx index e4f547f27d5..35a357899de 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # qiskit.qobj.PulseQobjExperimentConfig - + A config for a single Pulse experiment in the qobj. Instantiate a PulseQobjExperimentConfig object. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.mdx index 4c95ef2027b..35b6e65bb53 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # qiskit.qobj.PulseQobjInstruction - + A class representing a single instruction in an PulseQobj Experiment. Instantiate a new PulseQobjInstruction object. @@ -69,7 +69,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.mdx index b01e7f83dc0..30527a563b5 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # qiskit.qobj.QasmExperimentCalibrations - + A container for any calibrations data. The gates attribute contains a list of GateCalibrations. Initialize a container for calibrations. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.mdx index 17cae2d75fa..4b83accd2cc 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # qiskit.qobj.QasmQobj - + A QASM Qobj. Instantiate a new QASM Qobj Object. @@ -47,7 +47,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.mdx index 5da03e69e36..14997915d8b 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # qiskit.qobj.QasmQobjConfig - + A configuration for a QASM Qobj. Model for RunConfig. @@ -65,7 +65,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.mdx index ccd5c2a5609..29df6e8da2e 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # qiskit.qobj.QasmQobjExperiment - + A QASM Qobj Experiment. Each instance of this class is used to represent a QASM experiment as part of a larger QASM qobj. @@ -43,7 +43,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.mdx index c57304bedda..ff901ebeaa1 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # qiskit.qobj.QasmQobjExperimentConfig - + Configuration for a single QASM experiment in the qobj. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.mdx index 69e46a95e1a..6630ff5f7e8 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # qiskit.qobj.QasmQobjInstruction - + A class representing a single instruction in an QasmQobj Experiment. Instantiate a new QasmQobjInstruction object. @@ -59,7 +59,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.28/qiskit.qobj.Qobj.mdx index 5705e4deb1f..169ce45de43 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # qiskit.qobj.Qobj - + A backwards compat alias for QasmQobj. Initialize a Qobj object. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.mdx index 1dd0f5cf429..da866fe9674 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # qiskit.qobj.QobjExperimentHeader - + A class representing a header dictionary for a Qobj Experiment. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.mdx index fb82221b6fc..0c4c82f9f83 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # qiskit.qobj.QobjHeader - + A class used to represent a dictionary header in Qobj objects. Instantiate a new Qobj dict field object. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.mdx index 8c8dd23b449..df3d336588f 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # qiskit.qobj.QobjMeasurementOption - + An individual measurement option. Instantiate a new QobjMeasurementOption object. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.mdx index 165dfc75235..71643d5d9d4 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # qiskit.quantum\_info.CNOTDihedral - + An N-qubit operator from the CNOT-Dihedral group. > The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -166,7 +166,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### dim - + Return tuple (input\_shape, output\_shape). @@ -217,7 +217,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### qargs - + Return the qargs for the operator. @@ -281,7 +281,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.mdx index 81a85cbdbcb..137a8b3fcdd 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # qiskit.quantum\_info.Chi - + Pauli basis Chi-matrix representation of a quantum channel. The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -109,7 +109,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -161,13 +161,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -242,7 +242,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -280,7 +280,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -310,13 +310,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.mdx index 5188009bb13..1f26d60f119 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # qiskit.quantum\_info.Choi - + Choi-matrix representation of a Quantum Channel. The Choi-matrix representation of a quantum channel $\mathcal{E}$ is a matrix @@ -117,7 +117,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -169,13 +169,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -250,7 +250,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -288,7 +288,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -318,13 +318,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.mdx index 8637a2b23d8..35bd1117755 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # qiskit.quantum\_info.Clifford - + An N-qubit unitary operator from the Clifford group. **Representation** @@ -159,13 +159,13 @@ python_api_name: qiskit.quantum_info.Clifford ### destabilizer - + Return the destabilizer block of the StabilizerTable. ### dim - + Return tuple (input\_shape, output\_shape). @@ -210,7 +210,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -232,13 +232,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.quantum_info.Clifford ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -332,7 +332,7 @@ python_api_name: qiskit.quantum_info.Clifford ### qargs - + Return the qargs for the operator. @@ -362,19 +362,19 @@ python_api_name: qiskit.quantum_info.Clifford ### settings - + Return operator settings. ### stabilizer - + Return the stabilizer block of the StabilizerTable. ### table - + Return StabilizerTable diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.mdx index f58dcb3484b..424609bd89c 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # qiskit.quantum\_info.DensityMatrix - + DensityMatrix class Initialize a density matrix object. @@ -94,7 +94,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### atol - + Default absolute tolerance parameter for float comparisons. @@ -112,13 +112,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### data - + Return data. ### dim - + Return total state dimension. @@ -227,7 +227,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -251,7 +251,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -277,7 +277,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -336,7 +336,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -480,7 +480,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### rtol - + Default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.mdx index d486aeacd8d..a94cfa03c75 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # qiskit.quantum\_info.Kraus - + Kraus representation of a quantum channel. For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -113,7 +113,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -165,13 +165,13 @@ $$ ### data - + Return list of Kraus matrices for channel. ### dim - + Return tuple (input\_shape, output\_shape). @@ -246,7 +246,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -284,7 +284,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -314,13 +314,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 248e35803d8..875345caeb2 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # qiskit.quantum\_info.OneQubitEulerDecomposer - + A class for decomposing 1-qubit unitaries into Euler angle rotations. The resulting decomposition is parameterized by 3 Euler rotation angle parameters $(\theta, \phi, \lambda)$, and a phase parameter $\gamma$. The value of the parameters for an input unitary depends on the decomposition basis. Allowed bases and the resulting circuits are shown in the following table. Note that for the non-Euler bases (U3, U1X, RR), the ZYZ Euler parameters are used. @@ -108,7 +108,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer ### basis - + The decomposition basis. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.mdx index 305d51baa0c..318f939ce10 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # qiskit.quantum\_info.Operator - + Matrix operator class This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication @@ -103,7 +103,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -151,13 +151,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -222,7 +222,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -260,7 +260,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -294,7 +294,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -340,13 +340,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.mdx index e1f608f0f14..1d6666f9414 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # qiskit.quantum\_info.PTM - + Pauli Transfer Matrix (PTM) representation of a Quantum Channel. The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by @@ -117,7 +117,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -169,13 +169,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -250,7 +250,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -288,7 +288,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -318,13 +318,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.mdx index 16ae6ea28a0..2bfdf032afa 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # qiskit.quantum\_info.Pauli - + N-qubit Pauli operator. This class represents an operator $P$ from the full $n$-qubit *Pauli* group @@ -319,7 +319,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -408,7 +408,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -522,7 +522,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -534,7 +534,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -554,7 +554,7 @@ $$ ### phase - + Return the group phase exponent for the Pauli. @@ -582,13 +582,13 @@ $$ ### qargs - + Return the qargs for the operator. ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -633,7 +633,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -647,7 +647,7 @@ $$ ### settings - + Return settings. **Return type** @@ -657,7 +657,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](#qiskit.quantum_info.Pauli.compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](#qiskit.quantum_info.Pauli.dot "qiskit.quantum_info.Pauli.dot"). @@ -818,13 +818,13 @@ $$ ### x - + The x vector for the Pauli. ### z - + The z vector for the Pauli. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.mdx index ddbe9040e73..9c00f4f40e3 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # qiskit.quantum\_info.PauliList - + List of N-qubit Pauli operators. This class is an efficient representation of a list of [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") operators. It supports 1D numpy array indexing returning a [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") for integer indexes or a [`PauliList`](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") for slice or list indices. @@ -335,7 +335,7 @@ python_api_name: qiskit.quantum_info.PauliList ### dim - + Return tuple (input\_shape, output\_shape). @@ -432,7 +432,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** @@ -526,7 +526,7 @@ python_api_name: qiskit.quantum_info.PauliList ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -538,7 +538,7 @@ python_api_name: qiskit.quantum_info.PauliList ### phase - + Return the phase exponent of the PauliList. @@ -566,7 +566,7 @@ python_api_name: qiskit.quantum_info.PauliList ### qargs - + Return the qargs for the operator. @@ -596,19 +596,19 @@ python_api_name: qiskit.quantum_info.PauliList ### settings - + Return operator settings. ### shape - + The full shape of the `array()` ### size - + The number of Pauli rows in the table. @@ -801,13 +801,13 @@ python_api_name: qiskit.quantum_info.PauliList ### x - + The x array for the symplectic representation. ### z - + The z array for the symplectic representation. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.mdx index 525333641ef..5185514bd33 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # qiskit.quantum\_info.PauliTable - + Symplectic representation of a list Pauli matrices. **Symplectic Representation** @@ -143,13 +143,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). @@ -201,7 +201,7 @@ $$ ### array - + The underlying boolean array. @@ -328,7 +328,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -411,7 +411,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** @@ -502,7 +502,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -536,7 +536,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -566,7 +566,7 @@ $$ ### settings - + Return settings. **Return type** @@ -576,13 +576,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.mdx index fd3e4e0ec1b..0eb5a748d67 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # qiskit.quantum\_info.Quaternion - + A class representing a Quaternion. ### \_\_init\_\_ @@ -31,7 +31,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.mdx index da5d460920b..776f02fec0f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # qiskit.quantum\_info.ScalarOp - + Scalar identity operator class. This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. @@ -80,13 +80,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeff - + Return the coefficient @@ -134,7 +134,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -191,7 +191,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -221,7 +221,7 @@ python_api_name: qiskit.quantum_info.ScalarOp ### qargs - + Return the qargs for the operator. @@ -251,13 +251,13 @@ python_api_name: qiskit.quantum_info.ScalarOp ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.mdx index 44556b1d82c..f3f692501fc 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # qiskit.quantum\_info.SparsePauliOp - + Sparse N-qubit operator in a Pauli basis representation. This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. @@ -92,13 +92,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### atol - + Default absolute tolerance parameter for float comparisons. ### coeffs - + Return the Pauli coefficients. @@ -146,7 +146,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### dim - + Return tuple (input\_shape, output\_shape). @@ -191,13 +191,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -284,7 +284,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -318,7 +318,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### qargs - + Return the qargs for the operator. @@ -348,13 +348,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return settings. **Return type** @@ -383,13 +383,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### size - + The number of Pauli of Pauli terms in the operator. ### table - + Return the the PauliTable. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.mdx index 4d3b46f98c8..726933670c3 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # qiskit.quantum\_info.StabilizerState - + StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). ```python @@ -93,7 +93,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### clifford - + Return StabilizerState Clifford data @@ -111,7 +111,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### dim - + Return total state dimension. @@ -216,7 +216,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.mdx index ca3ea307041..0fd42e7be0f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # qiskit.quantum\_info.StabilizerTable - + Symplectic representation of a list Stabilizer matrices. **Symplectic Representation** @@ -157,13 +157,13 @@ $$ ### X - + The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). ### Z - + The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). @@ -217,7 +217,7 @@ $$ ### array - + The underlying boolean array. @@ -355,7 +355,7 @@ $$ ### dim - + Return tuple (input\_shape, output\_shape). @@ -447,7 +447,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. @@ -550,7 +550,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -562,13 +562,13 @@ $$ ### pauli - + Return PauliTable ### phase - + Return phase vector @@ -596,7 +596,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -626,7 +626,7 @@ $$ ### settings - + Return settings. **Return type** @@ -636,13 +636,13 @@ $$ ### shape - + The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") ### size - + The number of Pauli rows in the table. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.mdx index a520a4c4e5e..c24a3a5f5df 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # qiskit.quantum\_info.Statevector - + Statevector class Initialize a statevector object. @@ -95,7 +95,7 @@ python_api_name: qiskit.quantum_info.Statevector ### atol - + Default absolute tolerance parameter for float comparisons. @@ -113,13 +113,13 @@ python_api_name: qiskit.quantum_info.Statevector ### data - + Return data. ### dim - + Return total state dimension. @@ -256,7 +256,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -280,7 +280,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -365,7 +365,7 @@ python_api_name: qiskit.quantum_info.Statevector ### num\_qubits - + Return the number of qubits if a N-qubit state or None otherwise. @@ -509,7 +509,7 @@ python_api_name: qiskit.quantum_info.Statevector ### rtol - + Default relative tolerance parameter for float comparisons. @@ -571,7 +571,7 @@ python_api_name: qiskit.quantum_info.Statevector ### settings - + Return settings. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.mdx index 7e93de6b5b7..875a8df002f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # qiskit.quantum\_info.Stinespring - + Stinespring representation of a quantum channel. The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -115,7 +115,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -167,13 +167,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -248,7 +248,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -286,7 +286,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -316,13 +316,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.mdx index 37a53c1298c..0a17e626309 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # qiskit.quantum\_info.SuperOp - + Superoperator representation of a quantum channel. The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by @@ -109,7 +109,7 @@ $$ ### atol - + Default absolute tolerance parameter for float comparisons. @@ -161,13 +161,13 @@ $$ ### data - + Return data. ### dim - + Return tuple (input\_shape, output\_shape). @@ -242,7 +242,7 @@ $$ ### num\_qubits - + Return the number of qubits if a N-qubit operator or None otherwise. @@ -280,7 +280,7 @@ $$ ### qargs - + Return the qargs for the operator. @@ -310,13 +310,13 @@ $$ ### rtol - + Default relative tolerance parameter for float comparisons. ### settings - + Return operator settings. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 045d92adcf4..dbbba0cc237 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # qiskit.quantum\_info.TwoQubitBasisDecomposer - + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.28/qiskit.result.Counts.mdx b/docs/api/qiskit/0.28/qiskit.result.Counts.mdx index 174702ed40b..eeff9a70251 100644 --- a/docs/api/qiskit/0.28/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.28/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # qiskit.result.Counts - + A class to store a counts result from a circuit execution. Build a counts object diff --git a/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.mdx index f428ce5f76e..f03f8e1c16f 100644 --- a/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # qiskit.result.ProbDistribution - + A generic dict-like class for probability distributions. Builds a probability distribution object. diff --git a/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.mdx index 80addc16358..917b8795fcb 100644 --- a/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # qiskit.result.QuasiDistribution - + A dict-like class for representing qasi-probabilities. Builds a quasiprobability distribution object. diff --git a/docs/api/qiskit/0.28/qiskit.result.Result.mdx b/docs/api/qiskit/0.28/qiskit.result.Result.mdx index 47259ccd335..edc2428d498 100644 --- a/docs/api/qiskit/0.28/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.28/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # qiskit.result.Result - + Model for Results. ### backend\_name @@ -124,7 +124,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.28/qiskit.result.ResultError.mdx index 7fde61b1e90..311f900e13a 100644 --- a/docs/api/qiskit/0.28/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.28/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.mdx index f4368736d7b..9f706edddc5 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # qiskit.scheduler.ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.mdx index 104f69538c5..dcef6539892 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # qiskit.transpiler.AnalysisPass - + An analysis pass: change property set, not DAG. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.mdx index b51158f2a65..cda5c69cceb 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # qiskit.transpiler.CouplingMap - + Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### distance\_matrix - + Return the distance matrix for the coupling map. @@ -133,25 +133,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### is\_symmetric - + Test if the graph is symmetric. Return True if symmetric, False otherwise @@ -207,7 +207,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### physical\_qubits - + Returns a sorted list of physical\_qubits diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.mdx index 4b075068bcb..75a6571fa6f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # qiskit.transpiler.FencedDAGCircuit - + A dag circuit that cannot be modified (via remove\_op\_node) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.mdx index a7a8d2cc53b..fa51d017a8b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # qiskit.transpiler.FencedPropertySet - + A property set that cannot be written (via \_\_setitem\_\_) ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.mdx index 9a5ca0c6af2..2a994dde092 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # qiskit.transpiler.FlowController - + Base class for multiple types of working list. This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.mdx index 5f2e827456e..e194eefa9fd 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # qiskit.transpiler.InstructionDurations - + Helper class to provide durations of instructions for scheduling. It stores durations (gate lengths) and dt to be used at the scheduling stage of transpiling. It can be constructed from `backend` or `instruction_durations`, which is an argument of `transpile()`. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.Layout.mdx index b367f609f80..73e5c9bee4b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # qiskit.transpiler.Layout - + Two-ways dict to represent a Layout. construct a Layout from a bijective dictionary, mapping virtual qubits to physical qubits @@ -135,7 +135,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -217,7 +217,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.mdx index fd95d7117c6..cb4dfcb838c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # qiskit.transpiler.PassManager - + Manager for a set of Passes and their scheduling during transpilation. Initialize an empty PassManager object (with no passes scheduled). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.mdx index 32a65b62c7b..18d6c62734e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # qiskit.transpiler.PassManagerConfig - + Pass Manager Configuration. Initialize a PassManagerConfig object diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.mdx index e3ec6a877e1..9cbed13e92e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # qiskit.transpiler.PropertySet - + A default dictionary-like object ### \_\_init\_\_ diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.mdx index ac06943a403..b9eeff6c218 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # qiskit.transpiler.TransformationPass - + A transformation pass: change DAG, not property set. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.mdx index ee1987f6370..8d1ac99214f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.mdx index e8c16662989..54f1c0173a2 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.mdx index 518519ed8ec..14604567ee7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # qiskit.transpiler.passes.ALAPSchedule - + ALAP Scheduling. ALAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.mdx index 003ec1d5792..a84bbd7f00b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # qiskit.transpiler.passes.ASAPSchedule - + ASAP Scheduling. ASAPSchedule initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.mdx index ca7132cd443..619dc161d8a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # qiskit.transpiler.passes.AlignMeasures - + Measurement alignment. This is a control electronics aware optimization pass. @@ -82,7 +82,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -90,7 +90,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.mdx index 0351a0c3fc2..a33f385decb 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # qiskit.transpiler.passes.ApplyLayout - + Transform a circuit with virtual qubits into a circuit with physical qubits. Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits by applying the Layout given in property\_set. Requires either of passes to set/select Layout, e.g. SetLayout, TrivialLayout. Assumes the Layout has full physical qubits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.mdx index c7381d69b77..be8cc9ef2df 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # qiskit.transpiler.passes.BIPMapping - + Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. The BIP mapper tries to find the best layout and routing at once by solving a BIP (binary integer programming) problem as described in \[1]. @@ -100,7 +100,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -108,7 +108,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 628d739cf2a..019d615c0d9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # qiskit.transpiler.passes.BarrierBeforeFinalMeasurements - + Add a barrier before final measurements. This pass adds a barrier before the set of final measurements. Measurements are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.mdx index 95d4c8b6c95..7f5216d023e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # qiskit.transpiler.passes.BasicSwap - + Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.mdx index 1df2a0f5251..3b9678756c9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # qiskit.transpiler.passes.BasisTranslator - + Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. This pass operates in several steps: @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.mdx index 3e68996c95f..93f25be7cd7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # qiskit.transpiler.passes.CSPLayout - + If possible, chooses a Layout as a CSP, using backtracking. If possible, chooses a Layout as a CSP, using backtracking. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.mdx index fd96cabbe41..cc0f94f0397 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # qiskit.transpiler.passes.CXCancellation - + Cancel back-to-back cx gates in dag. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.mdx index 65a29bcdde1..abcd1e9fbb4 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # qiskit.transpiler.passes.CXDirection - + Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. GateDirection pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.mdx index 18fdb9864d0..4b5abefb415 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # qiskit.transpiler.passes.CheckCXDirection - + Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.mdx index 6d16db0ed47..5e6a8f7daf1 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # qiskit.transpiler.passes.CheckGateDirection - + Check if the two-qubit gates follow the right direction with respect to the coupling map. CheckGateDirection initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.mdx index d1172ed5b1a..3fddd4bf9ef 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # qiskit.transpiler.passes.CheckMap - + Check if a DAG circuit is already mapped to a coupling map. Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be physically close, setting the property `is_swap_mapped` to `True` or `False` accordingly. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.mdx index eeff2b0d067..709b6f43f58 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # qiskit.transpiler.passes.Collect2qBlocks - + Collect sequences of uninterrupted gates acting on 2 qubits. Traverse the DAG and find blocks of gates that act consecutively on pairs of qubits. Write the blocks to property\_set as a dictionary of the form: @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.mdx index 80dc63c1aae..067a82f4d9d 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # qiskit.transpiler.passes.CommutationAnalysis - + Analysis pass to find commutation relations between DAG nodes. Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. @@ -38,7 +38,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.mdx index 7dd3e027084..314b8253992 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # qiskit.transpiler.passes.CommutativeCancellation - + Cancel the redundant (self-adjoint) gates through commutation relations. Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include: @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.mdx index c5afab68a80..d41ea845170 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # qiskit.transpiler.passes.ConsolidateBlocks - + Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.mdx index ab43683fe60..d806c9f9b03 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # qiskit.transpiler.passes.CountOps - + Count the operations in a DAG circuit. The result is saved in `property_set['count_ops']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOps ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 2401a437cc2..6b79214f773 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # qiskit.transpiler.passes.CountOpsLongestPath - + Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 2a8de004427..4fc1b0f7546 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # qiskit.transpiler.passes.CrosstalkAdaptiveSchedule - + Crosstalk mitigation through adaptive instruction scheduling. CrosstalkAdaptiveSchedule initializer. @@ -216,7 +216,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -230,7 +230,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.mdx index df4129418e9..392df46d9ed 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # qiskit.transpiler.passes.DAGFixedPoint - + Check if the DAG has reached a fixed point. A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.mdx index 45e1d6363d4..db99172431e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # qiskit.transpiler.passes.DAGLongestPath - + Return the longest path in a DAGcircuit as a list of DAGNodes. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.mdx index a9b2b5c0a21..7fe1e93bdda 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # qiskit.transpiler.passes.Decompose - + Expand a gate in a circuit using its decomposition rules. Decompose initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Decompose ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.mdx index e1126ab15a4..cfb9ac12577 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # qiskit.transpiler.passes.DenseLayout - + Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.mdx index 8e6686e2a6c..7bfc05f90c9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # qiskit.transpiler.passes.Depth - + Calculate the depth of a DAG circuit. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Depth ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 3c7ccfb4985..5fef134d5dd 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # qiskit.transpiler.passes.DynamicalDecoupling - + Dynamical decoupling insertion pass. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. @@ -111,7 +111,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -119,7 +119,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index aa12c65082e..d431e778c8a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # qiskit.transpiler.passes.EnlargeWithAncilla - + Extend the dag with virtual qubits that are in layout but not in the circuit yet. Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the `layout` property, by a previous pass. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.mdx index 68d1e9ae006..043dae9f2f1 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # qiskit.transpiler.passes.FixedPoint - + Check if a property reached a fixed point. A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.mdx index d5ce83598c2..e1ea79531b7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # qiskit.transpiler.passes.FullAncillaAllocation - + Allocate all idle nodes from the coupling map as ancilla on the layout. A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla. @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.mdx index f607f0fb2a5..c99478fc7bb 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # qiskit.transpiler.passes.GateDirection - + Modify asymmetric gates to match the hardware coupling direction. This pass makes use of the following identities: @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.mdx index d4105dd4e68..0680f9463bf 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # qiskit.transpiler.passes.Layout2qDistance - + Evaluate how good the layout selection was. Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.mdx index 0b8e0b01432..4e73cab6229 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # qiskit.transpiler.passes.LookaheadSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of Sven Jandura’s swap mapper submission for the 2018 Qiskit Developer Challenge, adapted to integrate into the transpiler architecture. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 490d1a5c575..4f72621bd7c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # qiskit.transpiler.passes.MergeAdjacentBarriers - + Return a circuit with any adjacent barriers merged together. Only barriers which can be merged without affecting the barrier structure of the DAG will be merged. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index fc74589cc33..fe797e9fc1c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # qiskit.transpiler.passes.NoiseAdaptiveLayout - + Choose a noise-adaptive Layout based on current calibration data for the backend. > This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit), using calibration data. @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.mdx index 9b3553266ba..b0c83c246d8 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # qiskit.transpiler.passes.NumTensorFactors - + Calculate the number of tensor factors of a DAG circuit. The result is saved in `property_set['num_tensor_factors']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.mdx index 5fa3a5c218f..7c724d37f5f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # qiskit.transpiler.passes.Optimize1qGates - + Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. Optimize1qGates initializer. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 1e84f898203..a43d57dadec 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # qiskit.transpiler.passes.Optimize1qGatesDecomposition - + Optimize chains of single-qubit gates by combining them into a single gate. Optimize1qGatesDecomposition initializer. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 13977d29fa4..e7928ccbe99 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # qiskit.transpiler.passes.RZXCalibrationBuilder - + Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). Initializes a RZXGate calibration builder. @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -84,7 +84,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 3114717d237..88ee48bd200 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho - + Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. The `RZXCalibrationBuilderNoEcho` is a variation of the [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder") pass that creates calibrations for the cross-resonance pulses without inserting the echo pulses in the pulse schedule. This enables exposing the echo in the cross-resonance sequence as gates so that the transpiler can simplify them. The `RZXCalibrationBuilderNoEcho` only supports the hardware-native direction of the CX gate. @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -88,7 +88,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.mdx index d9971ec516b..f4400845346 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # qiskit.transpiler.passes.RemoveBarriers - + Return a circuit with any barrier removed. This transformation is not semantics preserving. @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 2460a156628..3850f7c31a0 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure - + Remove diagonal gates (including diagonal 2Q gates) before a measurement. Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measurement. Including diagonal 2Q gates. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index ea9da5a3b59..83a0f338d30 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # qiskit.transpiler.passes.RemoveFinalMeasurements - + Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as the ClassicalRegisters they are connected to if the ClassicalRegister is unused. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index a7ff61586f9..c3e136cfd7c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # qiskit.transpiler.passes.RemoveResetInZeroState - + Remove reset gate when the qubit is in zero state. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.mdx index 8283922142e..a63e58466eb 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # qiskit.transpiler.passes.SabreLayout - + Choose a Layout via iterative bidirectional routing of the input circuit. Starting with a random initial Layout, the algorithm does a full routing of the circuit (via the routing\_pass method) to end up with a final\_layout. This final\_layout is then used as the initial\_layout for routing the reverse circuit. The algorithm iterates a number of times until it finds an initial\_layout that reduces full routing cost. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.mdx index 79cf2e26045..10cdae32276 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # qiskit.transpiler.passes.SabreSwap - + Map input circuit onto a backend topology via insertion of SWAPs. Implementation of the SWAP-based heuristic search from the SABRE qubit mapping paper \[1] (Algorithm 1). The heuristic aims to minimize the number of lossy SWAPs inserted and the depth of the circuit. @@ -126,7 +126,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -134,7 +134,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.mdx index a961943c67b..a784f7b4e87 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # qiskit.transpiler.passes.SetLayout - + Set the `layout` property to the given layout. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit) in increasing order. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.mdx index 2cef2e80045..615b51debd4 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # qiskit.transpiler.passes.Size - + Calculate the size of a DAG circuit. The result is saved in `property_set['size']` as an integer. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Size ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.mdx index fa902a2e41b..03e8b117ca7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # qiskit.transpiler.passes.StochasticSwap - + Map a DAGCircuit onto a coupling\_map adding swap gates. Uses a randomized algorithm. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.mdx index 6b66022e421..d2b40a39383 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # qiskit.transpiler.passes.TemplateOptimization - + Class for the template optimization pass. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.mdx index e6ed8e752f2..dbbe99a4e42 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # qiskit.transpiler.passes.TimeUnitConversion - + Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. This pass will add a .duration metadata to each op whose duration is known, which will be used by subsequent scheduling passes for scheduling. @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.mdx index a7ac9ae046f..7806bf621e0 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # qiskit.transpiler.passes.TrivialLayout - + Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. A pass for choosing a Layout of a circuit onto a Coupling graph, using a simple round-robin order. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.mdx index c9601302e74..fb595ab6d5a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # qiskit.transpiler.passes.UnitarySynthesis - + Synthesize gates according to their basis gates. Synthesize unitaries over some basis gates. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 0ab92635b46..96b85b11a40 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # qiskit.transpiler.passes.Unroll3qOrMore - + Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ### \_\_init\_\_ @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 40fcc4ce6e8..e5a4eb66382 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # qiskit.transpiler.passes.UnrollCustomDefinitions - + Unrolls instructions with custom definitions. Unrolls instructions with custom definitions. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.mdx index c5a41e39748..083cd213ec3 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # qiskit.transpiler.passes.Unroller - + Unroll a circuit to a given basis. Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction. @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Unroller ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.mdx index 01711f9b8b1..fb47405663d 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # qiskit.transpiler.passes.ValidatePulseGates - + Check custom gate length. This is a control electronics aware analysis pass. @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.mdx index 0053fca48cb..b648937ff6e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # qiskit.transpiler.passes.Width - + Calculate the width of a DAG circuit. The result is saved in `property_set['width']` as an integer that contains the number of qubits + the number of clbits. @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_analysis\_pass - + Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Width ### is\_transformation\_pass - + Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). diff --git a/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.mdx index 73b23d486cb..458a3e48dfc 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # qiskit.utils.QuantumInstance - + Quantum Backend including execution setting. Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance. @@ -124,25 +124,25 @@ python_api_name: qiskit.utils.QuantumInstance ### backend - + Return BaseBackend backend object. ### backend\_config - + Getter of backend\_config. ### backend\_name - + Return backend name. ### backend\_options - + Getter of backend\_options. @@ -166,19 +166,19 @@ python_api_name: qiskit.utils.QuantumInstance ### cals\_matrix\_refresh\_period - + returns matrix refresh period ### circuit\_summary - + Getter of circuit summary. ### compile\_config - + Getter of compile\_config. @@ -213,19 +213,19 @@ python_api_name: qiskit.utils.QuantumInstance ### is\_local - + Return True if backend is a local backend. ### is\_simulator - + Return True if backend is a simulator. ### is\_statevector - + Return True if backend is a statevector-type simulator. @@ -249,25 +249,25 @@ python_api_name: qiskit.utils.QuantumInstance ### measurement\_error\_mitigation\_cls - + returns measurement error mitigation cls ### measurement\_error\_mitigation\_shots - + returns measurement error mitigation shots ### noise\_config - + Getter of noise\_config. ### qjob\_config - + Getter of qjob\_config. @@ -283,7 +283,7 @@ python_api_name: qiskit.utils.QuantumInstance ### run\_config - + Getter of run\_config. @@ -295,13 +295,13 @@ python_api_name: qiskit.utils.QuantumInstance ### skip\_qobj\_validation - + checks if skip qobj validation ### time\_taken - + Accumulated time taken for execution. **Return type** diff --git a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.mdx index e8687447be0..c1ac2513dd0 100644 --- a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.mdx index 1d68ca9f179..ee4d0ffbcc9 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 9bb16dc7f2a..2649e457f04 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # qiskit.visualization.pulse\_v2.IQXDebugging - + Pulse stylesheet for pulse programmers. Show details of instructions. \# TODO: add more generators diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.mdx index 460fd00ec3e..c5c8b77b2b6 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # qiskit.visualization.pulse\_v2.IQXSimple - + Simple pulse stylesheet without channel notation. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.mdx index 5562a889754..769db41c3b6 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # qiskit.visualization.pulse\_v2.IQXStandard - + Standard pulse stylesheet. * Generate stepwise waveform envelope with latex pulse names. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.mdx index 67e1c0f35e0..e577542c2bf 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # qiskit.visualization.qcstyle.DefaultStyle - + Creates a Default Style dictionary **Style Dict Details** diff --git a/docs/api/qiskit/0.29/logging.mdx b/docs/api/qiskit/0.29/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.29/logging.mdx +++ b/docs/api/qiskit/0.29/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.mdx index 27bbb468033..868c57f157a 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.mdx index ce3b0f96ba6..e20a18111bd 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.mdx index c541e58a1df..b717e80e269 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.mdx index 17eb1853697..5c71dedbbb1 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.mdx index 00fe5f33265..7b60153afc2 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `object` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 70509ef002c..13f297c80c3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.mdx index 70ad6b4aac9..46c071c2558 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.mdx index 87f8f9daedf..3b83d666e6a 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.mdx index b3a77b6b9db..60697f8df81 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.mdx index d3c13046118..926c14a5a2c 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 71aa0b7e804..da6299681f6 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.Grover.mdx index 8a54d0aabeb..94ce6937615 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -126,7 +126,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.mdx index fa839512092..db3d7fda816 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.HHL.mdx index a4e9de7af3d..90d217a6b9b 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e6952740e95..82e9e4b2275 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 726bc19ddb6..2a6c97c6a47 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index bb5e2210467..9d0ec6dcaa6 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 48dbc87a0b1..f05969ede56 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.mdx index a9ebb7bb044..1cae4e83965 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.mdx index dcc0a8e1f50..e063b75d0c5 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.mdx index 4498e3ed742..68f299d8a59 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c60203087a5..b18d8cd3cd5 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 4d84642032b..10517e02a48 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.mdx index 756ebc0587b..1e7f05b57a2 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.mdx index 4099331d509..54cb3ed1107 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.mdx index a38ebecbb7a..b608d75dd2f 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.mdx index e1ffbabdca0..9debe18386d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ebcb21aa0d8..df1cc669880 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.mdx index a88f52356f2..532d2e5c729 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.mdx index 41de4387e57..e3262c9bf92 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.mdx index 258ebaef686..2471882a19a 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.mdx index ff950a6c2a1..ca740d09700 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -215,7 +215,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.Shor.mdx index a17bd5abdd8..9d78a9a43bd 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.mdx index c3e1f75812b..ba9ef7320b6 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.VQE.mdx index b220e0296b5..db3837890d0 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.mdx index b96c232ce64..9f31ba86c13 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.mdx index 9e2d1ea1b3d..090c58abf17 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.mdx index 7467bec47a8..af8f6e6a358 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.mdx index 11c359e84ec..4eb9d57eb3e 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.mdx index 1c93a34eefd..7de0ef061a3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.mdx index b9d9301afe8..b7271ebabba 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.mdx index 655a14df4e8..b3e3ed94133 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 354e31bc7c8..416e5ce797f 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.mdx index 9ddc42b2760..4da5c79bb4e 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.mdx index 3c0f22fb9ae..c0a001cbbb7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.mdx index 530732ff721..7e184732561 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -117,7 +117,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.mdx index 7e8c93af72b..4910f58e8ed 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.mdx index a93bb96b039..2cd15aa6907 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 61ddde0accc..c86aeef4204 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 432677ac538..1e28de32423 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx index 8fecaa95805..0d16ef55736 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.mdx index 5a0853a72b3..63ff55ed780 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 95cfd0c9224..64e5b9caea7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.mdx index 6b0d9afe1fd..66318cfcdf3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.mdx index 919c08c8b01..fcac617b5cf 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.mdx index 45fe58bf66c..f336435e757 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -100,7 +100,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -110,7 +110,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -144,7 +144,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -213,7 +213,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.mdx index 8c871303961..fa7cee21549 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.mdx index a49784b3a49..325141ee691 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.mdx index 7d1895a56c3..56d78602473 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -129,7 +129,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index fefb1663818..8c9a91d5ac6 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.mdx index fcb3446be45..868194f1061 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.29/qiskit.aqua.AquaError.mdx index 1f61f9c108e..fdb9020ae4b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.mdx index 7f2568205fe..f5c6442b543 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.mdx index e7cd4f84cc3..8ca862417e3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index ae18bbc59fe..bcbbb435929 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 0daca935eeb..06e5cfab49c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # AmplitudeEstimationAlgorithmResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` AmplitudeEstimationAlgorithm Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index 8e042284a76..16ee4734a6e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` AmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.mdx index d158e777dbf..1623ad79433 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # BernsteinVazirani - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index bafd330cb94..211a42e58d2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # ClassicalAlgorithm - + Bases: `abc.ABC` Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index 7ea1864f8cf..4ee685156f7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # ClassicalCPLEX - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.mdx index bc52ede6d91..f1e863e00d0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # DeutschJozsa - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.mdx index cf4fb86247b..a8bd3cf01e9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # EOH - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.mdx index 0bd258c29e4..b1bf5d10f37 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.mdx index 6ba69c1b56a..771cae801aa 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.mdx index b691284ec7a..20c5c47ecd2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # Grover - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Grover’s Search algorithm. @@ -132,7 +132,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.mdx index 34ff167c211..22754f143d1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # GroverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Grover Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.mdx index 91b20ef5214..44a9e97400e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # HHL - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The HHL algorithm. @@ -74,7 +74,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -93,7 +93,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -112,7 +112,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.mdx index 052864ee11a..2bd1c4108e8 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # HHLResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` HHL Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.mdx index 794aaa3e056..f1b8f6bc2cb 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # IQPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Iterative Quantum Phase Estimation algorithm. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index acfc3344319..2c5cc177bbf 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index b4d4cc41f12..043cc9ca927 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` IterativeAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.mdx index d884d0798d3..cc31377928b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # LinearsolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Linear solver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 29abec34ad9..84dda7a68c6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index bf23c4e2c5a..21630a4c8c9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` MaximumLikelihoodAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 595f945114a..b5a49f30e72 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index b34c0a78193..d7c48d458c7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 66d526f91a9..97fabc6ac2d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 8f849c80ed2..a040186dd97 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # NumPyLSsolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 894372c48f6..13b32c25fb6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # NumPyLSsolverResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` Numpy LinearSystem Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7430c317278..69df9a4b40b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.mdx index a476d05a605..e80e2f5cf31 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # QAOA - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.mdx index 89844fbf513..0247d398c98 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # QGAN - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.mdx index 00ec2a39fda..2bb59eda2e7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # QPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Quantum Phase Estimation algorithm. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.mdx index b834ebe046a..46f191cc1c5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # QSVM - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Quantum SVM algorithm. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 0ba85ad92cd..f55e9a33a2a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # QuantumAlgorithm - + Bases: `abc.ABC` Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.mdx index 5e41c8e070b..2c0b77a00da 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # Shor - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Shor’s factoring algorithm. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.mdx index a0e34d193c5..f57574cfaa1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # Simon - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Simon algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.mdx index c6048af9e22..4fc369c2dc0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # SklearnSVM - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.mdx index d4fb976a730..9d3e50a3404 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # VQC - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.mdx index a2c65fb86af..fd46719101a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # VQE - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.mdx index 5bf84eaa937..cbe5430c32c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # CNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.mdx index a8a1baf02af..4ceb6aea257 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # DNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.mdx index 3c79c6e8093..ee982de53b9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # ESOP - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index abd32e1cdc0..5e74db7bb5d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # PhaseEstimationCircuit - + Bases: `object` Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.mdx index aae1333c99d..667eff19e84 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # StateVectorCircuit - + Bases: `object` Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.mdx index d5d517e89c9..ce90c018fd2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # WeightedSumOperator - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Adds q^T \* w to separate register for non-negative integer weights w. @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.mdx index 675c831dc5a..83aadbb5491 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # Eigenvalues - + Bases: `abc.ABC` Base class for eigenvalue estimation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.mdx index f8ee08c4353..867e7349794 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # EigsQPE - + Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.mdx index c3ee92ba022..abe7deed93e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # FeatureMap - + Bases: `abc.ABC` Base class for FeatureMap. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index 27b7f557148..7c89e12dabc 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` Raw Feature Vector feature map. @@ -48,13 +48,13 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.mdx index 6447c481b53..d1e18855453 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # Custom - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The custom initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.mdx index a6f130beaed..0375875d925 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # InitialState - + Bases: `abc.ABC` Base class for InitialState. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.mdx index ef0e560fb3d..895fa842fd9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # VarFormBased - + Bases: `object` The variational form based initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.mdx index 4a900516297..58397e57632 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # Zero - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 77097eaa48f..2fb87e48c22 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # AllPairs - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 2b86bad395f..5c9987ed5da 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # ErrorCorrectingCode - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 8781ea7ca25..cbd49a120ba 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # MulticlassExtension - + Bases: `abc.ABC` Base class for multiclass extension. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index d23ad79895b..38481ba0356 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # OneAgainstRest - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index ab65b051646..f6d227cfd49 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # DiscriminativeNetwork - + Bases: `abc.ABC` Base class for discriminative Quantum or Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 2d499b7cae3..cac1ab34f29 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # GenerativeNetwork - + Bases: `abc.ABC` Base class for generative Quantum and Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_discriminator - + Set discriminator network. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 3fc887bc77b..49ab5bce4f3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # NumPyDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on NumPy diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 6bf01bb0067..05eebaff1e2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # PyTorchDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index 87237b296d8..adcd045b540 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # QuantumGenerator - + Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` Quantum Generator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.mdx index 38f6182d7ec..49b16fa83c0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # ADAM - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -174,7 +174,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.mdx index e4a9969bf4d..a363ba2b977 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # AQGD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.mdx index 7946e658e48..8ce7b43d6a0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.mdx index 6ad5978091c..61747582c08 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # CG - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Conjugate Gradient optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.mdx index 24695fa91a2..a39df858920 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # COBYLA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Constrained Optimization By Linear Approximation optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.mdx index c80d56326d4..28421a7117a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # CRS - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8fe0fbb9941..1f9667b6351 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 12e9e03ca89..ec2a74e5812 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.mdx index 5fefe583b59..9e156b22bbf 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # ESCH - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.mdx index b7b984313da..5f22a8130a1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # GSLS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.mdx index 49fa6c8cab6..fc70bfd3b7b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # IMFIL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.mdx index 95a45c07256..125ba03e926 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # ISRES - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index 21af907f212..0479473c1d1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Limited-memory BFGS Bound optimizer. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index b363ba9e541..a2e75f2f8da 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nelder-Mead optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx index e8f4594a56d..e2fef891fa7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # NFT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nakanishi-Fujii-Todo algorithm. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.mdx index 2fa3469e9e7..cfd9af18e80 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 89a9711d203..f07f7589643 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.mdx index 4168ebac7c4..9b8a190e473 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # POWELL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Powell optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.mdx index 35656a9b66a..7a177a4aa99 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Parallelized Limited-memory BFGS optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.mdx index 06cc2c7f4d6..2079f7a18bc 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # SLSQP - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Sequential Least SQuares Programming optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.mdx index d1d18448d60..42cc5441e89 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.mdx index f46d3ceed8c..82ec517b53a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # SPSA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.mdx index b01ec640cb7..62c13f35160 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # TNC - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Truncated Newton (TNC) optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index 51c2f5e1f8b..4c68259fe2c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # CustomCircuitOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 80ee7dcc639..9ddc9616bdd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # LogicalExpressionOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.mdx index 39f5057a134..62e7faa0e5b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # Oracle - + Bases: `abc.ABC` Base class for oracles. @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### construct\_circuit - + Construct the oracle circuit. **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b5dc61c3e15..86be4315904 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # TruthTableOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.mdx index cce4819e748..90d09ff3d93 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # LongDivision - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.mdx index f3de6ac158c..511babc009f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # LookupRotation - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 876f8f0291f..fcfe3006f18 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # Reciprocal - + Bases: `abc.ABC` Base class for reciprocal calculation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index e768edb2794..62b51684d0e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # BernoulliDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Bernoulli Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 258208b5e7d..534f31cdd8e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # GaussianConditionalIndependenceModel - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Gaussian Conditional Independence Model for Credit Risk. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 432cd96cf0c..57cdba473a6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Log-Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index 8edeb4ad3be..33c01da171f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # MultivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 6f560d7308d..43b9eb602a5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # MultivariateLogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Log-Normal Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 44d51bf056d..f1e6753aa4d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # MultivariateNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 1608f07c2c8..6133bdbc1d6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # MultivariateUniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index 0932c015e84..f7ac71e1c92 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # MultivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 1626074359f..5f8b8875461 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # NormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index c16dd214eb2..2cae4333fac 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # UncertaintyModel - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Model @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index c1ac9100b11..de7467baae0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # UniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index ab17adfb748..cb750abe7cb 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # UnivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 8b3617dd0a8..5d6126aa9fe 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # UnivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index a9248fe6448..d9cb3d537b8 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # MultivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index fd8663cc6cc..b352bbe186e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # UncertaintyProblem - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Problem component. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 4125c130a9d..f543616d1b9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # UnivariatePiecewiseLinearObjective - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index 0bcb7444ed2..9fc1c64460a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # UnivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 5fe7e97318b..6b76c6fdef4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # VariationalForm - + Bases: `abc.ABC` Base class for VariationalForms. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -38,13 +38,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.mdx index 8b44044f882..65c3a716ced 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # OperatorBase - + Bases: `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -215,7 +215,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -239,7 +239,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 35ae8dafe00..354d867e3bd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.mdx index f520786ca64..7d23f01f9fe 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.mdx index ca51807c240..d1b1f422204 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 8053614e1e9..35e0d17232f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 49f46ff191f..3f2a214b837 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index 1984cf9a1ea..375e277a801 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index d55eabac99e..441d103b8d9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 544b5754497..a74eaa6117a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index ed1d68d349e..7096815aa6c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 70008eddffc..b414ebc507a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.mdx index 38629cb322d..3597748905c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # QDrift - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.mdx index 0d51887cb44..d9ecb3ad50e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # Suzuki - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.mdx index 93db0f61340..036e2f90c12 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # Trotter - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index 34ae6002646..52b858a4920 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 3aad16d1d37..3c630187687 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index da4e371d1f9..19c6c955784 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index bb8c3de0464..f673d4ebe67 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 1c3700e8777..cadd3c880da 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index 6795b9d8bbc..ef805ab5a47 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index f1e4176222c..2fe236a6f68 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.mdx index 3a6018906da..632fc594d4e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a7327e44e85..f048a7a8335 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 0bfdbf04e73..db85991aab9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.mdx index 6bd56bc19e6..35b5c9fdf05 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.mdx index fc18de875f7..e4c10595f35 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # Gradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.mdx index 009e7db36c6..e44c2be84fd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # GradientBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.mdx index 5752da18ad7..e63aad1202c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # Hessian - + Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.mdx index 00a946d2f99..56c66197221 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # HessianBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.mdx index f7ca7efcc59..850e9b1cd22 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.mdx index 1aad7ff4fad..c17ed5bbdf9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # QFI - + Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). @@ -70,7 +70,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.mdx index aa6f14122df..8e6619bc01c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # QFIBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index 7ae719f1b69..ad1c096634c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # LegacyBaseOperator - + Bases: `abc.ABC` Operators relevant for quantum applications. @@ -19,41 +19,41 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 7ac3f7afa7b..8de3f523e9e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # MatrixOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.mdx index 4d7d389194f..d43bc0ab342 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # PauliGraph - + Bases: `object` Pauli Graph. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index 424b0158386..8a450ff0dca 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # TPBGroupedWeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` TPB Grouped Weighted Pauli Operator @@ -246,7 +246,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -281,7 +281,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -427,7 +427,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -495,7 +495,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 9affe5f72cb..e12842aca91 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # WeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Weighted Pauli Operator @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index 5d900e25ac2..129cdcb1c31 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.mdx index ce01ab9dd91..67721bf3695 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.mdx index 45b52c955eb..cf42d2f9e48 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # ListOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.mdx index 341158f2a21..a27638803c1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # SummedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.mdx index 07abb514ca3..7d3ba79de8d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index fae608410e2..70667b867bd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index cc0f9e32acc..4e034c91803 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index 041a8c01567..d45a822f6bd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index dcba818f021..d2f8e6dde9c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index 61a7259a3b9..bb5714becf9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index e94241c69df..45248c10242 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.mdx index ad8040977a0..7feeca20e57 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 16fe296b89b..4a4e01fdfb3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.mdx index ed74b7583dc..5437497d9f6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # StateFn - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 30e10867f00..4c0c59406e8 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.mdx index d7f8dbdc4fa..ecc044c4948 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # CircuitFactory - + Bases: `abc.ABC` Base class for CircuitFactories @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.mdx index f1aa3759ed7..4abcc24e492 100644 --- a/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.mdx index 14b70f34e1b..0e69b3e1327 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # BosonicOperator - + Bases: `object` A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.mdx index 755645ff9e0..a2531481b19 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # FermionicOperator - + Bases: `object` A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.mdx index aaef115478c..7d69301eef0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # MP2Info - + Bases: `object` A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.mdx index 929578ad262..614e61aa471 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # QMolecule - + Bases: `object` Molecule data class containing driver result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.QMolecule ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ## Attributes diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.mdx index b71c74d9119..3152d6d8689 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.mdx index 76981917a3a..f7c6c8d4039 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # WatsonHamiltonian - + Bases: `object` Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.mdx index 7d59ab47203..d6254e5bfeb 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # AdaptVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.mdx index e2dbdd024c6..6bf04ba3ec8 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 7acf3e6d4e5..49fb5b86b42 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # EigensolverFactory - + Bases: `abc.ABC` A factory to construct a eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index a0662dd68b0..5054491f56f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # ExcitedStatesEigensolver - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 027fa1147f3..a8b9598a9d0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # ExcitedStatesSolver - + Bases: `abc.ABC` The excited states calculation interface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index b9b6ad6443d..4a910e2152d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # GroundStateEigensolver - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.mdx index 3267792eda6..b7ccf1d806a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # GroundStateSolver - + Bases: `abc.ABC` The ground state calculation interface @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index 8331af81f9e..8648cfeb832 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # MinimumEigensolverFactory - + Bases: `abc.ABC` A factory to construct a minimum eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index 8dc4c0de270..d13cc425e53 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # NumPyEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index e89fb1a8975..45e182fe353 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # NumPyMinimumEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index 0dc46d97840..9d0f0952027 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # OrbitalOptimizationVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.mdx index d92b8179a2c..03c18ce3b96 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # QEOM - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.mdx index 78a74d31efd..5aff9c4972b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # QEomEE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` QEomEE algorithm (classical) @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.mdx index 2eb99aada68..d5857a50e93 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # QEomVQE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` QEomVQE algorithm @@ -223,7 +223,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.mdx index 54dc2ad2973..74d85b7a88c 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # VQEAdapt - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 8fca437e6a9..d4a06ddeaa7 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # VQEUCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index a63b36a8272..2c6ed355267 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # VQEUVCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 0b390840a9c..bd5d4b229bf 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index a683fa04370..c0dc669f3c9 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # DifferentialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 27e410e16ff..b7275963137 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # EnergySurface1DSpline - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 25f70a61af8..3525e0c6eeb 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # EnergySurfaceBase - + Bases: `abc.ABC` Class to hold a potential energy surface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 8de6427da62..1de65277293 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # Extrapolator - + Bases: `abc.ABC` This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index a0206544ee6..25f9ed9bcff 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # HarmonicPotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Harmonic potential. @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 5015706a5f2..c902bd422a1 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # MorsePotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Morse potential. @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 615e12be689..ecf635421eb 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # PCAExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index a3a29eb223e..27a27dae52f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # PolynomialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 51dd046f4ec..c65d6156956 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # PotentialBase - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index aff661e9ed8..052e9f0b416 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # SieveExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index b815a63e469..d3370db7f4a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # VibronicStructureBase - + Bases: `abc.ABC` Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 171d29acd52..a7adb5d18a6 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # WindowExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index a2fda7467db..269402d4ade 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # MolecularGroundStateEnergy - + Bases: `object` Molecular ground state energy chemistry application @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 12b0e129750..b4cb06bf40d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # BosonicBasis - + Bases: `object` Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 21f29c60ca5..4d704c7766a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # HarmonicBasis - + Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0477a2e77de..2ca5a0596e4 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # HartreeFock - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.mdx index ad1d3a4b809..e1a82a2acca 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # VSCF - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.mdx index 0069a69dce6..e94b20d9231 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # CHC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is the Compact Heuristic for Chemistry. @@ -57,13 +57,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.mdx index d766d177baf..f55983c9e8f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # UCCSD - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -133,13 +133,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -242,7 +242,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.mdx index c562d5ba4f0..ced5cd3749b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # UVCC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. @@ -29,7 +29,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -92,13 +92,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.mdx index f3b5d34f829..26ce880b1b6 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # ChemistryOperator - + Bases: `abc.ABC` Base class for ChemistryOperator. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.mdx index c3d02503c31..8b77571600f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # Hamiltonian - + Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.mdx index de6c15fb604..2b7a47f7d00 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # MolecularChemistryResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Molecular chemistry Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 28e1b45db45..d19d2e6800b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # MolecularExcitedStatesResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Excited States Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.mdx index ed8e6534764..2d9ffbe9404 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # MolecularGroundStateResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Ground State Energy Result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.mdx index 666348dcaf4..78f73393146 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # QubitMappingType - + Bases: `enum.Enum` QubitMappingType enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.mdx index 9392f1f0b1f..5abc45e71b5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # TransformationType - + Bases: `enum.Enum` Transformation Type enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.mdx index 7c6c9ab9cfc..4747a964ac0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # BaseDriver - + Bases: `abc.ABC` Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.mdx index a7db32a28f3..073f583e8d1 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # BasisType - + Bases: `enum.Enum` Basis Type diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.mdx index aff1c967000..868bbee07c2 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # BosonicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry bosonic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 1216408cf01..599da6276eb 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # FCIDumpDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an FCIDump file. @@ -34,7 +34,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.mdx index e9f6b72ef12..2c42a3f2938 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # FermionicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry fermionic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.mdx index 5943db9b76d..0640d92fc2e 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # GaussianDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index 85a7aecafed..7c8678b3ba7 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # GaussianForcesDriver - + Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 4ad402137c9..b42232db85d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # GaussianLogDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.mdx index 08aa4bcfdff..9d9e7705241 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # GaussianLogResult - + Bases: `object` Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.mdx index b1bfd83ed76..2983f4b353e 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # HDF5Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.mdx index dc08dc847e3..162b3eb2516 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # HFMethodType - + Bases: `enum.Enum` HFMethodType Enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.mdx index 08a7733eeec..c9820ee0f8f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # InitialGuess - + Bases: `enum.Enum` Initial Guess Enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.mdx index a36d0286020..2acdd987aaa 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # Molecule - + Bases: `object` Driver-independent Molecule definition. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.mdx index 5c6813a19cb..aedb8e779b4 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # PSI4Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.mdx index 97894cf400b..926f0304864 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # PyQuanteDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.mdx index 362eeb690e9..a5ee29a3b09 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # PySCFDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.mdx index b66a5973b75..23b7a5bae69 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # UnitsType - + Bases: `enum.Enum` Units Type Enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.mdx index d5bff92b6b0..75f25624bb0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # BOPESSamplerResult - + Bases: `object` The BOPES Sampler result diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.mdx index 8d6bc9c45be..1524ed59c22 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # EigenstateResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` The eigenstate result interface. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.mdx index ce464992806..9ad2a642d9d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # ElectronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The electronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.mdx index 12a0c43f6e0..ead9f5c13f4 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # VibronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The vibronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 02f6d520c2b..4a289e1ef83 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # BosonicQubitMappingType - + Bases: `enum.Enum` BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.mdx index 080a2134680..44dd5f5c967 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # BosonicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.mdx index ab2a11023aa..12e20b37cf5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # BosonicTransformationType - + Bases: `enum.Enum` BosonicTransformationType enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index c6edc0b9f8e..ff4e023ff8b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # FermionicQubitMappingType - + Bases: `enum.Enum` FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.mdx index 9350be4572c..b14ecf68ea8 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # FermionicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.mdx index 6057596e1f1..32242e07ede 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # FermionicTransformationType - + Bases: `enum.Enum` Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.mdx index 111d61a35ad..e74bb582df2 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # Transformation - + Bases: `abc.ABC` Base class for transformation to qubit operators for chemistry problems @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.mdx index e60f961a777..e47582ab82b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.mdx index 9e027ef7a14..155d16095cc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.mdx index 2cd323170ec..ee67c6dbbb2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Clbit.mdx index 8742163072d..2408d0c4582 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.mdx index b3ca1f4682d..6be7c042a27 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Delay.mdx index e43ee362cb9..9256f3dcff1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.mdx index 651d72bda11..816820911ab 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Gate.mdx index 77f20409a2f..e3bb4de81e8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Instruction.mdx index 623dffe5d2e..c10723365bc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.mdx index 1b7ccd3f0d3..cd4813aa260 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Measure.mdx index da8cad9d7a2..bafd07ccd01 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Parameter.mdx index d7e431a9f44..f9589202387 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.mdx index 651174034d8..47bbf312381 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.mdx index 841f8fa7ea9..09dc0d53847 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.mdx index dd19203c211..ef8662f628b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -307,7 +307,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -343,13 +343,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -765,7 +765,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -783,7 +783,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.mdx index 7d2c607e976..d6bdc91fd07 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Qubit.mdx index 93f7ea5dc0f..cf400cfe296 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.29/qiskit.circuit.Reset.mdx index c685f9c77a8..fbf9b90ccd7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 8bcbf85ae5f..32565987ed0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 2f0d39e7816..5f28d3fd55b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index c5f63a79721..8746dfcea75 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 68e24fb0a52..1c216593b03 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.AND.mdx index aae6d1662da..08c3368aede 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.mdx index 5ec7657d560..10ed222937d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.mdx index 471b65e9eaa..e123f194577 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.mdx index 068492e37b1..666c938d95a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.mdx index ff67e0fb9cb..b1f9f816f80 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.mdx index 2a81088aa70..17cd9845d20 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index d120d3e0db9..c4f9d926524 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.mdx index 20f12274078..7b0ab2d6d5a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.mdx index 6cebdde31dc..d52a658510c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.mdx index bd2447ddf5c..ab0bc1546df 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.mdx index 8b83153fa3d..a86a9329f07 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.mdx index 89064272392..f8f7814144a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.mdx index 00737bd9d36..082e5838b5f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.mdx index cd20a5736fa..211d99aa74d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.mdx index ae6885f5be0..40672693ada 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.mdx index e49b6e7c11f..16deee0f985 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.mdx index 612d0d89207..7459bb2291a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.mdx index 0f8eb3e9b60..7c63ea96316 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.mdx index 428538007fe..ae7f4cd903e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.mdx index ff804eedc5c..6a34cd3cfe2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.mdx index 733ae6e1174..6150234bdf4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.mdx index 1bad671175d..21888cd13e1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.mdx index eb2b8f5ce77..92c71676148 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.mdx index 3e8e9d89928..4c6c5e3806d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.mdx index 81befc09631..035079ea0fe 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index e4cb2e7a4d9..408c134706d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.mdx index 528cb5941b4..61fc022081b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.mdx index 281d6a53ad3..031344a660d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.mdx index c9fb976b93e..721b89664e8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.mdx index 2aa3a21728f..9deb3192ef8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GR.mdx index 3d35154102c..71bc9a838e8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.mdx index be85fb70614..ce7ee8030a0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.mdx index 6a8539d7213..1e57f686328 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.mdx index 7b45706325f..f81a261f956 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.mdx index 9a0a8d4fa1b..eadfe9250cc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.mdx index e64f9455368..5334bb15cb7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.mdx index 4e7be8b3485..fc616994cee 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index c712a8b1ca2..cc6f25936bd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.mdx index d1fa5bc1a04..dc68b0ad37e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.mdx index bbe9cd36e7c..daecfc664c6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.mdx index fa8827a8a7a..ff185dab1d8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.mdx index 4d4155bc246..eca93ad60f3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.mdx index 608168ff59c..7d602c274e5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.mdx index e3dd9e3f0d3..634d578d7a5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.mdx index 7a1eb0cdb05..59417e3e4bd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.mdx index 6ad70a48e7e..81592cfa921 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.mdx index 7209542a00f..1b1576d5e9d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.mdx index aae13bd190e..50662cbe4a3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.mdx index 10bd3fc657f..636244be9fc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.mdx index 8aee00f1a45..ef62d61bb74 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.mdx index 139c6d4cb8a..0aef8882f4e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.mdx index 83de799f5c7..0a25b85a0de 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.mdx index e236d61fcf0..8403196e4d8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.mdx index 1d5dc918cb9..6c46c743963 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.mdx index 5fc86d31022..dc2c6961452 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.mdx index 3f629df8ab9..20f6fefa821 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.mdx index 77bb89c4c35..ee329f61bb8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # NormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.OR.mdx index c6bebd0214b..5862a0b52ac 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.mdx index a3344152d4b..dab5273262b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.mdx index 41cc1f8a31c..6c26563d6c9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.mdx index c74fc599567..daac5d40a87 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.mdx index 2344ff90eb6..4054272496e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.mdx index 536082ceb6d..1b3a979a99b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.mdx index 1e1f5fe65aa..b6696b68f9e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.mdx index 4ce585eb7a2..ef39cdfd5d8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.mdx index 02a3502a439..361d4d9c9c1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 7869b940f22..7b195724d43 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 6b8ec05bb79..34e828e2f3f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.mdx index 8d2108ee68e..ae353d11676 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.mdx index 5001376e2b7..ac6b6ef75c7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.mdx index 7d172a9c0d5..79b9f3aa65c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.mdx index 10d6a1992ad..2516d78e22b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.mdx index d47f5e81bcc..927f07382bc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.mdx index e765a279443..0db3a0f9e2b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.mdx index 1735b1b0e90..963ac994d72 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.mdx index 145e1a19d88..d28a5bc44fb 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.mdx index febbde25953..486941396dd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.mdx index 4e387b6353a..cf5f45608ef 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.mdx index f37a6592f72..de8afd18c2c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.mdx index a4ce87e1bc7..d0906b419f3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.mdx index 5fcfa9cd0ed..4c06fd205ac 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.mdx index a44258ef907..6e8e8d56282 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.mdx index 4fa70db923b..512e12e89a0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.mdx index af89584b29c..c1260d87b78 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.mdx index 7e51b7670c6..3a796a0a655 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.mdx index 704c0d7ba04..b03a3e1f4c2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.mdx index 3eef29d039d..7d80ece1a58 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.mdx index 63188080383..458f10b1f10 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.mdx index aab13bfa833..b4889a59440 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.mdx index df31e9a2384..14eb9de8c51 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.mdx index e3e0e5626c5..e10f453cba7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.mdx index a9011593cd3..9cab7c51fd8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.mdx index a1f033cc5aa..7eef8140bb3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.mdx index 5718062f000..90e6226eff3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.mdx index 8bfc12282f6..2f7a8e08058 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.mdx index 1ac3846ca02..3e67dfd31ac 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.mdx index 9b88878b07c..495b2e00c43 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.mdx index 4074cf925a3..95252b4175a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.mdx index ee8b10cc227..a2735f93635 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.mdx index 5335f5df3f2..f436b5c3122 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # UniformDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.mdx index a64b8bdb714..7c4d1d57d2d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.mdx index 0dcfe94e82d..36497bbe0e4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.mdx index 42b392fdb1d..460485d15ed 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.mdx index ac3957934e3..0e7ddc697b5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.mdx index fbbc51ee788..f7fad5ed841 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.mdx index bc889bd5caa..463fac676c1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.mdx index 2f7edd290e0..4f0c40184c2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.mdx index 75aa982bf0f..705e7880612 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.mdx index ef7aa70fb20..455b12f2a95 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.mdx index 41c943cb863..bc021697fd1 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -257,7 +257,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.mdx index 74f1ba48a24..011f90528ed 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.mdx index 83e4ac1a1d4..f7d2cc4e0b8 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.mdx index 2cb2674edfd..60b0855825c 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.mdx index 838039d329f..61c5a3da024 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Object to represent the information at a node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.mdx index 3fb3afe478c..8bdaa059049 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.29/qiskit.extensions.Initialize.mdx index 2f3978fe2dd..8ad775b6a7b 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.29/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.mdx index f62fefcea9d..7c4483b3fa3 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.mdx index e8882b47179..86f03620389 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.mdx index 7bb360e35a2..36e35864bdf 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 9f1837295fc..2d456d2c7ac 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # EuropeanCallDelta - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Delta. diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index cfaab07cd5a..1f4c494db7d 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # EuropeanCallExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index fd50bef69be..6e98b4e9cca 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # FixedIncomeExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.mdx index 7ab21f7e4b2..e85a4d89430 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # BaseDataProvider - + Bases: `abc.ABC` The abstract base class for data\_provider modules within Qiskit’s finance module. @@ -121,7 +121,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.mdx index d9d6253096a..d8110b835e2 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # DataOnDemandProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.mdx index a4e6691270f..389c570e825 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # ExchangeDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Exchange data provider. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.mdx index fc5d311e67d..a1c4aca6fdd 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # RandomDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.mdx index dd09960bba9..824586df72d 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # StockMarket - + Bases: `enum.Enum` Stock Market enum diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 6ef858ed112..770eb99bcb0 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # WikipediaDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Wikipedia data provider. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.mdx index 9b794c8d7f8..b9ec38bc96e 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # YahooDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Yahoo data provider. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.mdx index cd05419fed3..05559c16c31 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.mdx index 35c8a1f8cda..cb92ec9c3b1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.mdx index e2a89865c05..e4c187fc67e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.mdx index 471990a07c3..7fc9bf54c70 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 2cb64c711ed..907ea65daa7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.mdx index 796c8ad4114..cba2388ba9a 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.mdx index d48de97f326..dbcf94e40b7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.mdx index d9f67871d54..7bd3b0e303b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.mdx index 78d0b83b466..d807ec2f107 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.mdx index 96080ca5386..5ef118f9af9 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.mdx index 9d2427a8ffe..0a72032970b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.mdx index 26dc2c9fa22..82c89cffd5d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.mdx index 37b8b831ae2..9bbcb2f8e2b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.mdx index c0fb4f02719..1d904cf6d1f 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.mdx index 4c32dcdd7ab..6ba1b091dbb 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.mdx index 4b68060ec45..6a25583bf86 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index a618b199d11..161b844ccc0 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 478ad70845e..5aeff445ff1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index ff2dbb2f975..6fdbc42bfa7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index eef37cc454a..c46b2f5c2fc 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 8048a03f161..41360446c85 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 047b5fb7e9b..dc5f46377c6 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 1d4689c9640..a88584c6401 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 378183cec6f..12fe0816a7d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.mdx index c87a2d0c724..40f693d31d1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index b10b5ddb96e..0f8fb908ad5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.mdx index 640f0f02bde..ce42be2f0c3 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 54a4c0a6834..69caa71c49e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.mdx index dd4034ae2ff..355df13ef86 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.mdx index 43306903dd2..96b8c74f4d2 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.mdx index 1472cd43dbd..94622b107aa 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.mdx index 41ef30dd784..20201b456b7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index c24f99de034..96eeb848007 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.mdx index b90f47dbf0c..1ce31cc35c4 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.mdx index af9c13ef001..f9cda6c23ee 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.mdx index 3d69f841152..fcb8721075c 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.mdx index 90f03443e78..6ffe80939ea 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.mdx index d3c3debf0cd..711f5553506 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.mdx index 2ae6db88219..2adfadd93f8 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.mdx index 7f291d2d3ab..e95ddfe13f2 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.mdx index a7f21ebbf32..d2548d72895 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.mdx index cfd9db2f212..c1640cd317e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.mdx index 8f3f0e35819..2025a3632d3 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.mdx index 222e4029b77..7698bd99556 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.mdx index 14b608433d4..5f33f57f57c 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The raw feature vector circuit. @@ -128,7 +128,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -164,13 +164,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -586,7 +586,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -604,7 +604,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.mdx index 38d34b8c4df..149f4da528a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -207,7 +207,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -253,7 +253,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -271,7 +271,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.mdx index 69c8f8acafe..dd70307cb72 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.mdx index 06b358eb294..27943a01229 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.mdx index 09d211423d7..a14f211dacf 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.mdx index a1f404e66b6..d103f696cbd 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.mdx index 2febdbcdc38..abe43a3e1ab 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.mdx index 3e7b05568cf..89f3698a1b7 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.mdx index a2f9bc6ab12..1c6277cf6d9 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.mdx index 62e25e5412e..91bb9242c96 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.mdx index edb1f84d31d..4672e9e401e 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.mdx index 05af3b167a5..e6df4af3f09 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.mdx index 71d69092bd9..8b40ab664bb 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 6dac1bf3e20..0b8fe14fa33 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.mdx index 7ae4eed0cad..cd627826f11 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.mdx index 4bac8192c57..0d488be1b0c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.mdx index f19c6dedf5a..21699813034 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.mdx index d079c7dd33d..e314c4fc169 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.mdx index ce855140e8d..2601f58f901 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.mdx index 4aae59be22e..8e217c67c77 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.mdx index 6980e6d35d2..fc28ef6e490 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.mdx index 3bed350ae77..d75ae9f84f2 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.mdx index b0113af7825..341e9b4bdaa 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.mdx index 12acacdcaf7..ddad236dc9c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.mdx index e13e6fc2334..f8e0180659c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.mdx index 703b3aaeb23..4a8d87ccdf6 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.mdx index bd0311e7447..49a214c9a5b 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.mdx index 64aeb6d9cb8..5564b3d7f76 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.mdx index 0fc3150a6db..b3b61f5b5d1 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.mdx index a7e6e41a3b7..72a2c8000af 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.mdx index 4e19960c313..657d9e11304 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.mdx index 6ae5d1076cd..30e6dde2580 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.mdx index 79bceb8ff81..5deb277c4be 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.mdx index d4e81349854..78ab225933f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.mdx index 8223f03d774..9fc0b7412df 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.mdx index cb8494bf088..af8278bcf4d 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.mdx index b68bc55be03..5786e23fbd7 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.mdx index 503f03e3a0c..6be32eaa7c9 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.mdx index bf50c72e85f..06811dc1c54 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.mdx index e997228c2d8..d479c1d1de7 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.mdx index 394fccc90ab..e102b212a82 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.mdx index a266dfe0bbc..0a86648c03f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 53af0f3650c..e848d4068db 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backend by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index a3be025a6cd..e434d9ceb5f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 72b3f09afaa..ed3fa6516ee 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index da8ae03d781..1e18b9e151a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.mdx index ab08acd1f26..1eaf5b5fb9a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.mdx index 0bfffd6d323..b6b630d8622 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.mdx index bb30f9f1f3c..c0d39647960 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.mdx index b0a37588316..7edc0986e2a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index e0a6fd4b332..6b67ad6964f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.mdx index 5af81f4c8c6..75fc14d028c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.mdx index 3559ebab3ec..19969315164 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.mdx index 5a3c246fcfe..da2d10c2205 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.mdx index f91cf3e8057..37b7c663f62 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 51bef8ac0f3..dceed501e26 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # ADMMOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` ADMMOptimization Result. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 5208dfcc02f..79a48670ae4 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # ADMMOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.mdx index 77872f382be..692c38c30d5 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # ADMMParameters - + Bases: `object` Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.mdx index 40d6017d6fc..d6028e94257 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # ADMMState - + Bases: `object` Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.mdx index ea5943c1a0c..3430d5be0cb 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # CobylaOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.mdx index 227e3cca202..8bfe276e2d7 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # CplexOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -78,7 +78,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index d78d9e123c8..56ed0bd1297 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # GroverOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.mdx index 0be7733aa22..20c4a257e26 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # GroverOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.mdx index 971f2fe4fc1..fcb45add97a 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # IntermediateResult - + Bases: `enum.Enum` Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 69b81353b66..329d902f358 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # MinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index c81a65e4e0d..26221a7b870 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # MinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 975756bf3a2..d7b755212ad 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # MultiStartOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` An abstract class that implements multi start optimization and should be sub-classed by other optimizers. @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index ba9d9e23142..4a55a766f83 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # OptimizationAlgorithm - + Bases: `abc.ABC` An abstract class for optimization algorithms in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.mdx index 0cddaaf87f0..2fd25e78252 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # OptimizationResult - + Bases: `object` A base class for optimization results. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index 69057e9376e..e74eb11bd7b 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # OptimizationResultStatus - + Bases: `enum.Enum` Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 616b8f64191..3dee30e4fa4 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # RecursiveMinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index 6333eedba90..d0252360631 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # RecursiveMinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index e18a64f6263..9aa5efdf8c9 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # SlsqpOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index b08d49889fe..a42fb7f32f0 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # SlsqpOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.mdx index a8f260f993a..3cb785a2b39 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # SolutionSample - + Bases: `object` A sample of an optimization solution diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.mdx index cf48c3a499a..03dded7cc15 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # InequalityToEquality - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.mdx index da4d1c5a0d3..db9b19e4920 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # IntegerToBinary - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index c68ef9a78fb..47597b8cc71 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # LinearEqualityToPenalty - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 4768a441cb3..4cfbd2cad5e 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # QuadraticProgramConverter - + Bases: `abc.ABC` An abstract class for converters of quadratic programs in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index 14232d52624..76c36b0b3b7 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # QuadraticProgramToQubo - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a given optimization problem to a new problem that is a QUBO. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.mdx index 62dc54b369c..9a07e8e12e5 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # Constraint - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Abstract Constraint Class. @@ -26,7 +26,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.mdx index 6ab377f4fd8..687e040c0cc 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # LinearConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a linear constraint. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.mdx index 25c1c8a747d..76733cff526 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # LinearExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.mdx index 047bb47877c..1a56fe27952 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # QuadraticConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.mdx index 82dc22dda07..e593560cdcb 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # QuadraticExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.mdx index 3e44d3e0e65..170ea1222c8 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # QuadraticObjective - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.mdx index c8ba5b87a39..c3a0e312d1c 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.mdx index 6541045e346..99f1d864f19 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # QuadraticProgramElement - + Bases: `object` Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.mdx index de3b48f2933..28ab69d31fd 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # Variable - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a variable. diff --git a/docs/api/qiskit/0.29/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.29/qiskit.providers.Backend.mdx index da3a7652b55..5e05195f14c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.mdx index f69330f7c6b..72a40076aab 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.29/qiskit.providers.BackendV1.mdx index bd36632dc3a..f8006dd85c3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.mdx index b16a7eb6418..b5cbfd97b58 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.BaseJob.mdx index c9c50736acb..d4d52ea1329 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.mdx index 82bcb368239..215c5de8291 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.Job.mdx b/docs/api/qiskit/0.29/qiskit.providers.Job.mdx index 54ecc0c89b3..6508be69518 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.29/qiskit.providers.JobError.mdx index e0b4465d8da..9288a244b73 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.29/qiskit.providers.JobStatus.mdx index 26d97f65d9f..21cece14df9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.mdx index 0662d1b43b0..3034325f70d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.29/qiskit.providers.JobV1.mdx index e696713dfec..19f7a2ac088 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.29/qiskit.providers.Options.mdx b/docs/api/qiskit/0.29/qiskit.providers.Options.mdx index 30143726dce..e2a64db46ab 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `types.SimpleNamespace` Base options object diff --git a/docs/api/qiskit/0.29/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.29/qiskit.providers.Provider.mdx index a1e4820a314..41a8286de36 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.mdx index ccd9e916034..9f6a4375441 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.mdx index c9eed91c692..c8399f862b8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.mdx index 06d2b1e511a..9eaac21e3e0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.mdx index 2d729103f1d..952f92c053a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.mdx index 7a9a9c0326d..f1c613ca9c5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.mdx index 7a94437d7a3..92ee1736da8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -196,7 +196,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.mdx index deaa828fa97..cfdcb8f8cb1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -134,7 +134,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.mdx index 229f0cafae3..e01e7416db7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -168,7 +168,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.mdx index ac6e6417663..6ef45bf73a7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.mdx index 80485c0783d..4c601638d3f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.mdx index b590075e117..af8637169a8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -88,7 +88,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 7978630ce86..7241028cd25 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index f9f8ca93b4f..d2c8ade48e6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 7e1984409fa..f57a9150827 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -90,7 +90,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 11b5df387ac..a39c4f956c1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index bb6992c5dab..9378f23f1f0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.mdx index 794cbe961bc..87c71a0940c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 08536e7b959..c3c5f59c637 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 1b0f0fb672c..dae9b398811 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.mdx index 73e9df21377..af2ad493bdd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 3e544359571..f3db04e5687 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.mdx index a530f193798..8a0502a27df 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.mdx index 6dbcd0baa6f..e5697aa93e8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index 4dbc7b722da..186213a4fd1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.mdx index ed966bedda0..89846a8e14d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.mdx index e6e50d7e21e..a4c4f50233b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.mdx index 6c88a938b85..e87143f57b6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 8869cc06198..68ef435e55d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.mdx index 3f678f58769..d64f7ffc2bb 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.mdx index 175a86ab974..5fbfe16ba17 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.mdx index 096f906428d..367ccb986eb 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.mdx index 875ea9cb53e..ff86214684c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.mdx index 7ab84587f2c..3e05769ed37 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.mdx index 9fe3ffa08fe..437e89f4f7b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.mdx index c54df8ebee8..e0b2e469631 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.mdx index 8be1ff68675..88e3fece60c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.mdx index 613f0290cf0..c51045b0f7b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -178,7 +178,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -240,7 +240,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.mdx index 53933897f1c..7cf89b01aa0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `object` Quantum error class for Qiskit Aer noise model @@ -180,13 +180,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.mdx index 284be12096a..0c62e9c2f1c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -153,13 +153,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 3ed72db7d41..8d62ee3d8e7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.mdx index 115f52b24c5..6d88c7f27f0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.mdx index bd5d2c2b441..1d4d1312c2e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.mdx index a2c3bb842db..34e53bdba4e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.mdx index de74083a1a2..b37d065031f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9314006cf7d..78f741cd891 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 43cd26238a7..f6e9ed4ae0a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index e1c871e48d8..e7433a01f51 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.mdx index 87a58ecddbf..deef86d86a8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.mdx index acf7dea13c2..1cef34ddd06 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 9f7b11f9bbb..a267a303dbf 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 4b3dd0bd123..50454b6b26f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 4656c7eefc3..9e2e8720a26 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7593827c51a..992e51a1589 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.mdx index 4f9a2d49865..f92400576e0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 4968bed2f56..889f66c21b2 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.mdx index d265c048249..df3470f0efd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 7e1eb2366ee..ddc11bf97d5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 8918b3c15a8..ed5f8d51bf9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.mdx index 517715fb1c2..0350c1bce44 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.mdx index f9a6d262a38..f888462755d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.mdx index ee3eed7c1c2..2374fe7de65 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.mdx index 6d35caa9a69..0eaa2ed217a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.mdx index a5a2f6905cd..dc543bf8d88 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.mdx index d2ba98d03f6..32c56b54ca6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.mdx index 5fb913d2d5c..9fef217e121 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.mdx index 383bd2f3f75..335246f0a97 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 66ca122f221..a32773ba5b5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index d11d8f07f1e..56f780baad4 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 56fbe15d9db..90f3853d80f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 7a1e93d5891..cae73401c50 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 748a02f8580..975448f76d9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index f8f4969f0c4..64d51bab2d8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 25c3c7e1c85..861556e84de 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 1cf456260a9..85bc469a6a6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.mdx index 256373bbd02..2f2dd5526c4 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.mdx index d43fda4ad52..d35f097bab0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 2c4efd86fb2..4c8f9aa4bd8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.mdx index 658e6ec1259..20fb28a3214 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a8467f23800..b5996b8d424 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 6ad91c98487..3ba4abed37e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index c77033d74fb..43583364dd9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.mdx index 9e4043abf60..1a5a825b8a8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index cc674639cfc..0e267eca043 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 9642182f19b..723eaff7389 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 8868100c4c8..79146ebef7c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index ad1a0bd4c76..ac7f806b57d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index d42e6a07c18..42b25be1d2c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 7b7f7f8e817..a04946795f1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 812804215cf..185a3c90a5d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.mdx index 7497279fed6..effecb25df3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 7e993f34650..715b4c0bc91 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.mdx index 1ab5a4bb31c..fd68c2f7c69 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.mdx index 9437c784cc1..8ce5d306113 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index d12c8a28b30..94f3a4d8759 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 799e5f0e5e4..e6bfec0c66e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index e57fe4c0fa0..908034b4ed5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index e43d5d1a885..c3a81a8700a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index ee7fae87595..33bce80fc6c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 8f8f9271552..60c3d87a083 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index 7a6b8882150..6c3f4f7cd6f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 44efd236de2..ff3c6dd43e6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 5adb8cb9e1d..86f72b5561a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index de2c2bd43cd..16e12dda171 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 9a7a43c6c97..0d801476850 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.mdx index df3eec4af33..e918da4236c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.mdx index 77d1fdc8179..1c4bde79839 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.mdx index 21e87bf2375..721c21747af 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.Command.mdx index 16a2ea5505e..50cd1f6bf55 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.mdx index 13586a9d476..de60478e5a6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.mdx index cb44704c9f2..47616218175 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.mdx index 237830bbcb9..7e6ba952bd2 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.mdx index f94da9524c7..ec2aa302e11 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.mdx index af5fb36db89..9c26f781764 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.mdx index 007d38dcc2a..6c09d232fda 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Acquire.mdx index c46affcf243..eaeab81591a 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.mdx index 3b4390572c3..c5d06bd8ed0 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # AcquireChannel - + Bases: `qiskit.pulse.channels.Channel` Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Call.mdx index f151ba8efd1..47fb7c293de 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Constant.mdx index 03b3cf4f08c..0f0be66e7b3 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.mdx index d3d4550a91a..03b83c73efa 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Delay.mdx index 6274766068b..72ede7938b6 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Drag.mdx index d641be206ca..69cfb7778df 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.mdx index b0c081287e1..6342fe06263 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.mdx index 7239447283c..e3140a854d3 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.mdx index b7627fb089a..edf5e9e1848 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Instruction.mdx index 12dcbd180c2..7887bd36a08 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.mdx index 34ab0f5aba0..97d2b9a6ae5 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.mdx index 2406d6ddad0..5ffae39cddf 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.mdx index ed27d7e5171..a1667df5ff0 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.Channel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Play.mdx index e1d51dadbcc..72d5412bab9 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.29/qiskit.pulse.PulseError.mdx index ca8a63aae19..6c4a5209ca4 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.mdx index 8b413549bda..22d9d2534cf 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.Channel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Schedule.mdx index 140ab9fc9f2..1c77775f356 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -296,7 +296,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.mdx index 8b97bfbb906..88da85b43ff 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -295,7 +295,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.mdx index 8fb5f108629..c3335f82fa3 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.mdx index 3e5d6200fde..de3cdce12bb 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.mdx index 93e46a07f22..9c9c766c12f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.mdx index fb79ac431eb..75edfdeaf40 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.mdx index 90858c62fda..5db8a3ef85f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.29/qiskit.pulse.Waveform.mdx index 780d837b6f8..9af0eb34e13 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.mdx index 0abccea3dab..501f81b2380 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.mdx index d639c707f65..8cb6fc9b292 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.mdx index ea1dc87c499..ccbd34db68f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.mdx index b593356bf32..dd7c65e99d7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.mdx index 0034967f27b..8b8ea86fed1 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.mdx index 984cfc81cd8..7cec9fadecc 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.mdx index b8f649e8eb0..9edbe40b8b4 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.mdx index 1b16be0b1a9..c2d69b0cb36 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.mdx index 50892b62692..a6831d826d5 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.mdx index 6c3dd77ea24..c350a17086a 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.mdx index 4184f268ebc..52e3da88aad 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.mdx index 80b66d60df7..bf98cdf5146 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.mdx index 2c61e27b4f6..f8b4d22ee56 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.mdx index 7182421becf..1b342d82041 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.mdx index fcd2b6c9539..da3b290edef 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.mdx index ff87cec855a..6aa25cb8683 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.29/qiskit.qasm.Qasm.mdx index dfe2bc265a3..ee416b485d7 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.29/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.29/qiskit.qasm.QasmError.mdx index 1fee3b72dd5..d644aafdce6 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.mdx index 3175a24235e..8a75e46f579 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.mdx index 07db1b7f478..94b7bc6e13b 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.mdx index 787f8e54b05..8ba473f21c7 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.mdx index b0dcded88f7..961f5fbc5eb 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.mdx index 6b0bc938ddf..1de601a7622 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.mdx index d615fb5e98b..7b584800b3c 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.mdx index 7f014f78fc6..0d2e71ac736 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.mdx index ed924abb218..aef0f5c9e38 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.mdx index 0938a0f479e..7eff2daa6b1 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.mdx index 6ab7b245f1a..760936cb3be 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.mdx index 492c4cb275d..ff4d9d86086 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.mdx index 5266d26b602..d6375345104 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.mdx index 5aa7935b61b..3a9b20709a6 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.mdx index 376ce1979d4..69f33477d2f 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.mdx index 645337a5946..4670a95d788 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.29/qiskit.qobj.Qobj.mdx index d3b93718154..304342d2ccc 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.mdx index 3a4e3bb91e3..61c2b439545 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.mdx index ae6aca77470..3b48e646c30 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.mdx index f7a32cf39ac..dcf3049a9ae 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.mdx index 23558fb64bd..f1eee674849 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.mdx index 63f21af5c05..3defd7bf44e 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.mdx index 79e5803cb2a..7ab00722f55 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.mdx index 76eb29b3662..d111340e1c3 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.mdx index c8ff5f7a644..c7794c4a04b 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.mdx index f0ab29c1830..2cf7a5617cb 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index cbcc74d4a49..e5814f3fd96 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.mdx index 3aa2cc46607..f6427a78321 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.mdx index f04a63d5a70..39e99d5a841 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.mdx index e9c62f99e8d..947d1c69b25 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -335,7 +335,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -455,7 +455,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -497,7 +497,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -542,7 +542,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -556,7 +556,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.mdx index 384f0747c7a..7688b49c388 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -363,7 +363,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.mdx index 63e36d9d2db..e9ee3c85c9e 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.mdx index 93182821c26..890fd2e73d7 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.mdx index 268a8a27469..987aa2217b8 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.mdx index 97088458d15..c7f0fe360f5 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -121,13 +121,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.mdx index 2b24f2e06f9..e017c9a2518 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.mdx index 06929c5ee5a..b270a8f90d3 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.mdx index e3f122155ac..9e9ec1833cb 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -178,7 +178,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -202,7 +202,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -228,7 +228,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.mdx index e6bae9cd6ea..0b106b77207 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.mdx index 435e5f7f66f..4a3d460e981 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 364a3315218..2306ef07ff4 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.29/qiskit.result.Counts.mdx b/docs/api/qiskit/0.29/qiskit.result.Counts.mdx index 158a1a4df8e..9b1b034e6d7 100644 --- a/docs/api/qiskit/0.29/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.29/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.mdx index 72cdecfa8a4..f6b6bfcbe5b 100644 --- a/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.mdx index 5244c68e1a8..64583f12b9d 100644 --- a/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.29/qiskit.result.Result.mdx b/docs/api/qiskit/0.29/qiskit.result.Result.mdx index 4501570076e..ef166e7a2db 100644 --- a/docs/api/qiskit/0.29/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.29/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.29/qiskit.result.ResultError.mdx index e80c051198f..9a2fb418993 100644 --- a/docs/api/qiskit/0.29/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.29/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.mdx index bceabdb134a..e8dfa7d43f6 100644 --- a/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.mdx index 0103bc72544..ba5f7702eb5 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.mdx index 665aa86e542..a685ebc5325 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -89,25 +89,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.mdx index 2dfb47712ab..552fc450f13 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.mdx index bf8cd388da6..bf46d7cb7bb 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.mdx index f3487c8d57f..afbf44b10fd 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.mdx index 4531ba5634b..d1c89542d6c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.Layout.mdx index 66dfdf1dce5..8e3a6f04683 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.mdx index dc44aadcefa..7d3750743a1 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.mdx index 0fdb65ac9b5..373ccf1770b 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.mdx index 1424acdfdf1..b78cd0675ff 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.mdx index 7454bf8f37b..83a209c7b15 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.mdx index 32abb7d32c7..f5e7ba9af8c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.mdx index 39abe7bc7fb..9eb783e480a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.mdx index 38295935694..d125742b206 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ALAP Scheduling. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.mdx index 51ceb2dfae9..3d6ff6d7001 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ASAP Scheduling. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.mdx index e293cbf19db..b54daca5578 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.mdx index 6897f1689f8..34c0da5a1e2 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.mdx index 78dad80e642..3c33be38436 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index d1fa3c2c55a..4600bbcdae9 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.mdx index 530cfa152a5..655038ed913 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.mdx index f688563cdda..83bba6c76db 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.mdx index 54cf75273fa..2ad60c74a37 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.mdx index a18492dcbfd..99943f34bbd 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.mdx index 3d66a5832ab..a54d042e870 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.mdx index 1db8bb2062d..6d4ed01da2c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.mdx index 2cb436c3808..aaa868860b1 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.mdx index bfbc0df66ea..f211a83dc2e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.mdx index fba6454cd0a..b77ba82085e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.mdx index a9b9525387c..ff1007a7e23 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.mdx index 5e26bc707ec..736f9f68af4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 2d6dd13bc91..1e3834dc7cc 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.mdx index e5fd169cc9f..df56f82a5a4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 147283b7486..735092c4c2e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 71908291200..77d3f828d3a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.mdx index 80f41d00250..77f9737e21c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.mdx index 616bc9db666..ffdbefa4bfe 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.mdx index 801dda46e8e..2148594fe22 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.mdx index 21b01bea5de..67f62e2503b 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.mdx index 51b17f3e8b1..8587a9fba15 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 80a93a6172a..d54f233f854 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 909b96f0577..9930da83fe2 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.mdx index 3b5f740f6e8..137acd1f151 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 509f1962490..d63279ef495 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.mdx index a6011195098..d69ea681de9 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.mdx index 7d156d59295..c41c95d13d1 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.mdx index 00eed73c469..2a69348ebf7 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 6afee12337a..3c21d1749b7 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 99ceb9d7892..1aeaf747b3a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.mdx index 598751f3e13..111e4e445a1 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.mdx index 464a43468d3..1e39bc9f9c4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 37570f0c4aa..24d9a6ab333 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 561f6872895..b42550a839d 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 30991351e79..f74732a93b6 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.mdx index 0b87683ad62..6080ea54ee3 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 1f34ed4cbd9..f180dc84fee 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 84cf5091c36..d074850769c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index a58a5f616e6..9a9854be12a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.mdx index 64cce077218..0bdd1e1f7e5 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.mdx index 304378dbd1e..68e0ee75ccb 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.mdx index 3c313b4afb5..4e5ef4b3199 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.mdx index f2944f69e21..8952d6b77a8 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.mdx index dffc58a8e88..412919a680d 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.mdx index 3424dba5bce..8681fba39b0 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.mdx index b9bb9d5aa99..fdf23171eaf 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.mdx index 55ae91c577b..95c98a4fed9 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.mdx index c647c006fef..d8de9ab7ab8 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f21a57c9603..509e4c7a572 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 228d354d16d..b249d1645c6 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.mdx index 84a0c29e7b7..49f13d101cf 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.mdx index 31bb14e608a..159c8b45b11 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.mdx index 41a31e8b8fe..ad3d7baa0da 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.mdx index 52ba4d23cf8..8e24ef8fd5f 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.mdx index c37360eb77c..ee9faa63b85 100644 --- a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.mdx index 78e42abd197..0190b8691f5 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.mdx index be478fc23ef..0fa502a9d79 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.mdx index 2d1e4fca4fc..a0f25da183f 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.mdx index 090758ed8db..39ada062624 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.mdx index ccfbaad8d57..44af67d38c5 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.30/logging.mdx b/docs/api/qiskit/0.30/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.30/logging.mdx +++ b/docs/api/qiskit/0.30/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.mdx index 27bbb468033..868c57f157a 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.mdx index ce3b0f96ba6..e20a18111bd 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.mdx index c541e58a1df..b717e80e269 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.mdx index 17eb1853697..5c71dedbbb1 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.mdx index 00fe5f33265..7b60153afc2 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `object` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 70509ef002c..13f297c80c3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.mdx index 70ad6b4aac9..46c071c2558 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.mdx index 87f8f9daedf..3b83d666e6a 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.mdx index b3a77b6b9db..60697f8df81 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.mdx index d3c13046118..926c14a5a2c 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 71aa0b7e804..da6299681f6 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.Grover.mdx index 8a54d0aabeb..94ce6937615 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -126,7 +126,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.mdx index fa839512092..db3d7fda816 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.HHL.mdx index a4e9de7af3d..90d217a6b9b 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e6952740e95..82e9e4b2275 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 726bc19ddb6..2a6c97c6a47 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index bb5e2210467..9d0ec6dcaa6 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 48dbc87a0b1..f05969ede56 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.mdx index a9ebb7bb044..1cae4e83965 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.mdx index dcc0a8e1f50..e063b75d0c5 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.mdx index 4498e3ed742..68f299d8a59 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c60203087a5..b18d8cd3cd5 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 4d84642032b..10517e02a48 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.mdx index 756ebc0587b..1e7f05b57a2 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.mdx index 4099331d509..54cb3ed1107 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.mdx index a38ebecbb7a..b608d75dd2f 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.mdx index e1ffbabdca0..9debe18386d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ebcb21aa0d8..df1cc669880 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.mdx index a88f52356f2..532d2e5c729 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.mdx index 41de4387e57..e3262c9bf92 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.mdx index 258ebaef686..2471882a19a 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.mdx index ff950a6c2a1..ca740d09700 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -215,7 +215,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.Shor.mdx index a17bd5abdd8..9d78a9a43bd 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.mdx index c3e1f75812b..ba9ef7320b6 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.VQE.mdx index b220e0296b5..db3837890d0 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.mdx index b96c232ce64..9f31ba86c13 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.mdx index 9e2d1ea1b3d..090c58abf17 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.mdx index 7467bec47a8..af8f6e6a358 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.mdx index 11c359e84ec..4eb9d57eb3e 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.mdx index 1c93a34eefd..7de0ef061a3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.mdx index b9d9301afe8..b7271ebabba 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.mdx index 655a14df4e8..b3e3ed94133 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 354e31bc7c8..416e5ce797f 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.mdx index 9ddc42b2760..4da5c79bb4e 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.mdx index 3c0f22fb9ae..c0a001cbbb7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.mdx index 530732ff721..7e184732561 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -117,7 +117,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.mdx index 7e8c93af72b..4910f58e8ed 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.mdx index a93bb96b039..2cd15aa6907 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 61ddde0accc..c86aeef4204 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 432677ac538..1e28de32423 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx index 8fecaa95805..0d16ef55736 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.mdx index 5a0853a72b3..63ff55ed780 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 95cfd0c9224..64e5b9caea7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.mdx index 6b0d9afe1fd..66318cfcdf3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.mdx index 919c08c8b01..fcac617b5cf 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.mdx index b68593c056f..6ccd956db86 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -104,7 +104,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -114,7 +114,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -148,7 +148,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -217,7 +217,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.mdx index 8c871303961..fa7cee21549 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.mdx index a49784b3a49..325141ee691 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.mdx index 7d1895a56c3..56d78602473 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -129,7 +129,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index fefb1663818..8c9a91d5ac6 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.mdx index fcb3446be45..868194f1061 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.30/qiskit.aqua.AquaError.mdx index 1f61f9c108e..fdb9020ae4b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.mdx index 7f2568205fe..f5c6442b543 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.mdx index e7cd4f84cc3..8ca862417e3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index ae18bbc59fe..bcbbb435929 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 0daca935eeb..06e5cfab49c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # AmplitudeEstimationAlgorithmResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` AmplitudeEstimationAlgorithm Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index 8e042284a76..16ee4734a6e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` AmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.mdx index d158e777dbf..1623ad79433 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # BernsteinVazirani - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index bafd330cb94..211a42e58d2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # ClassicalAlgorithm - + Bases: `abc.ABC` Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index 7ea1864f8cf..4ee685156f7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # ClassicalCPLEX - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.mdx index bc52ede6d91..f1e863e00d0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # DeutschJozsa - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.mdx index cf4fb86247b..a8bd3cf01e9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # EOH - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.mdx index 0bd258c29e4..b1bf5d10f37 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.mdx index 6ba69c1b56a..771cae801aa 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.mdx index b691284ec7a..20c5c47ecd2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # Grover - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Grover’s Search algorithm. @@ -132,7 +132,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.mdx index 34ff167c211..22754f143d1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # GroverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Grover Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.mdx index 91b20ef5214..44a9e97400e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # HHL - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The HHL algorithm. @@ -74,7 +74,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -93,7 +93,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -112,7 +112,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.mdx index 052864ee11a..2bd1c4108e8 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # HHLResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` HHL Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.mdx index 794aaa3e056..f1b8f6bc2cb 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # IQPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Iterative Quantum Phase Estimation algorithm. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index acfc3344319..2c5cc177bbf 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index b4d4cc41f12..043cc9ca927 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` IterativeAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.mdx index d884d0798d3..cc31377928b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # LinearsolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Linear solver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 29abec34ad9..84dda7a68c6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index bf23c4e2c5a..21630a4c8c9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` MaximumLikelihoodAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 595f945114a..b5a49f30e72 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index b34c0a78193..d7c48d458c7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 66d526f91a9..97fabc6ac2d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 8f849c80ed2..a040186dd97 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # NumPyLSsolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 894372c48f6..13b32c25fb6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # NumPyLSsolverResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` Numpy LinearSystem Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7430c317278..69df9a4b40b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.mdx index a476d05a605..e80e2f5cf31 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # QAOA - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.mdx index 89844fbf513..0247d398c98 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # QGAN - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.mdx index 00ec2a39fda..2bb59eda2e7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # QPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Quantum Phase Estimation algorithm. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.mdx index b834ebe046a..46f191cc1c5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # QSVM - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Quantum SVM algorithm. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 0ba85ad92cd..f55e9a33a2a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # QuantumAlgorithm - + Bases: `abc.ABC` Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.mdx index 5e41c8e070b..2c0b77a00da 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # Shor - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Shor’s factoring algorithm. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.mdx index a0e34d193c5..f57574cfaa1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # Simon - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Simon algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.mdx index c6048af9e22..4fc369c2dc0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # SklearnSVM - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.mdx index d4fb976a730..9d3e50a3404 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # VQC - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.mdx index a2c65fb86af..fd46719101a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # VQE - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.mdx index 5bf84eaa937..cbe5430c32c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # CNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.mdx index a8a1baf02af..4ceb6aea257 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # DNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.mdx index 3c79c6e8093..ee982de53b9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # ESOP - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index abd32e1cdc0..5e74db7bb5d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # PhaseEstimationCircuit - + Bases: `object` Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.mdx index aae1333c99d..667eff19e84 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # StateVectorCircuit - + Bases: `object` Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.mdx index d5d517e89c9..ce90c018fd2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # WeightedSumOperator - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Adds q^T \* w to separate register for non-negative integer weights w. @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.mdx index 675c831dc5a..83aadbb5491 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # Eigenvalues - + Bases: `abc.ABC` Base class for eigenvalue estimation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.mdx index f8ee08c4353..867e7349794 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # EigsQPE - + Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.mdx index c3ee92ba022..abe7deed93e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # FeatureMap - + Bases: `abc.ABC` Base class for FeatureMap. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index 27b7f557148..7c89e12dabc 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` Raw Feature Vector feature map. @@ -48,13 +48,13 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.mdx index 6447c481b53..d1e18855453 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # Custom - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The custom initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.mdx index a6f130beaed..0375875d925 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # InitialState - + Bases: `abc.ABC` Base class for InitialState. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.mdx index ef0e560fb3d..895fa842fd9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # VarFormBased - + Bases: `object` The variational form based initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.mdx index 4a900516297..58397e57632 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # Zero - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 77097eaa48f..2fb87e48c22 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # AllPairs - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 2b86bad395f..5c9987ed5da 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # ErrorCorrectingCode - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 8781ea7ca25..cbd49a120ba 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # MulticlassExtension - + Bases: `abc.ABC` Base class for multiclass extension. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index d23ad79895b..38481ba0356 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # OneAgainstRest - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index ab65b051646..f6d227cfd49 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # DiscriminativeNetwork - + Bases: `abc.ABC` Base class for discriminative Quantum or Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 2d499b7cae3..cac1ab34f29 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # GenerativeNetwork - + Bases: `abc.ABC` Base class for generative Quantum and Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_discriminator - + Set discriminator network. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 3fc887bc77b..49ab5bce4f3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # NumPyDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on NumPy diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 6bf01bb0067..05eebaff1e2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # PyTorchDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index 87237b296d8..adcd045b540 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # QuantumGenerator - + Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` Quantum Generator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.mdx index 38f6182d7ec..49b16fa83c0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # ADAM - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -174,7 +174,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.mdx index e4a9969bf4d..a363ba2b977 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # AQGD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.mdx index 7946e658e48..8ce7b43d6a0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.mdx index 6ad5978091c..61747582c08 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # CG - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Conjugate Gradient optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.mdx index 24695fa91a2..a39df858920 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # COBYLA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Constrained Optimization By Linear Approximation optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.mdx index c80d56326d4..28421a7117a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # CRS - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8fe0fbb9941..1f9667b6351 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 12e9e03ca89..ec2a74e5812 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.mdx index 5fefe583b59..9e156b22bbf 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # ESCH - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.mdx index b7b984313da..5f22a8130a1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # GSLS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.mdx index 49fa6c8cab6..fc70bfd3b7b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # IMFIL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.mdx index 95a45c07256..125ba03e926 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # ISRES - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index 21af907f212..0479473c1d1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Limited-memory BFGS Bound optimizer. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index b363ba9e541..a2e75f2f8da 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nelder-Mead optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx index e8f4594a56d..e2fef891fa7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # NFT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nakanishi-Fujii-Todo algorithm. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.mdx index 2fa3469e9e7..cfd9af18e80 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 89a9711d203..f07f7589643 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.mdx index 4168ebac7c4..9b8a190e473 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # POWELL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Powell optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.mdx index 35656a9b66a..7a177a4aa99 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Parallelized Limited-memory BFGS optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.mdx index 06cc2c7f4d6..2079f7a18bc 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # SLSQP - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Sequential Least SQuares Programming optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.mdx index d1d18448d60..42cc5441e89 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.mdx index f46d3ceed8c..82ec517b53a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # SPSA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.mdx index b01ec640cb7..62c13f35160 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # TNC - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Truncated Newton (TNC) optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index 51c2f5e1f8b..4c68259fe2c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # CustomCircuitOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 80ee7dcc639..9ddc9616bdd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # LogicalExpressionOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.mdx index 39f5057a134..62e7faa0e5b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # Oracle - + Bases: `abc.ABC` Base class for oracles. @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### construct\_circuit - + Construct the oracle circuit. **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b5dc61c3e15..86be4315904 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # TruthTableOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.mdx index cce4819e748..90d09ff3d93 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # LongDivision - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.mdx index f3de6ac158c..511babc009f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # LookupRotation - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 876f8f0291f..fcfe3006f18 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # Reciprocal - + Bases: `abc.ABC` Base class for reciprocal calculation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index e768edb2794..62b51684d0e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # BernoulliDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Bernoulli Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 258208b5e7d..534f31cdd8e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # GaussianConditionalIndependenceModel - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Gaussian Conditional Independence Model for Credit Risk. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 432cd96cf0c..57cdba473a6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Log-Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index 8edeb4ad3be..33c01da171f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # MultivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 6f560d7308d..43b9eb602a5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # MultivariateLogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Log-Normal Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 44d51bf056d..f1e6753aa4d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # MultivariateNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 1608f07c2c8..6133bdbc1d6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # MultivariateUniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index 0932c015e84..f7ac71e1c92 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # MultivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 1626074359f..5f8b8875461 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # NormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index c16dd214eb2..2cae4333fac 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # UncertaintyModel - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Model @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index c1ac9100b11..de7467baae0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # UniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index ab17adfb748..cb750abe7cb 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # UnivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 8b3617dd0a8..5d6126aa9fe 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # UnivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index a9248fe6448..d9cb3d537b8 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # MultivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index fd8663cc6cc..b352bbe186e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # UncertaintyProblem - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Problem component. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 4125c130a9d..f543616d1b9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # UnivariatePiecewiseLinearObjective - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index 0bcb7444ed2..9fc1c64460a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # UnivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 5fe7e97318b..6b76c6fdef4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # VariationalForm - + Bases: `abc.ABC` Base class for VariationalForms. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -38,13 +38,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.mdx index 8b44044f882..65c3a716ced 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # OperatorBase - + Bases: `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -215,7 +215,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -239,7 +239,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 35ae8dafe00..354d867e3bd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.mdx index f520786ca64..7d23f01f9fe 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.mdx index ca51807c240..d1b1f422204 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 8053614e1e9..35e0d17232f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 49f46ff191f..3f2a214b837 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index 1984cf9a1ea..375e277a801 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index d55eabac99e..441d103b8d9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 544b5754497..a74eaa6117a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index ed1d68d349e..7096815aa6c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 70008eddffc..b414ebc507a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.mdx index 38629cb322d..3597748905c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # QDrift - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.mdx index 0d51887cb44..d9ecb3ad50e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # Suzuki - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.mdx index 93db0f61340..036e2f90c12 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # Trotter - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index 34ae6002646..52b858a4920 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 3aad16d1d37..3c630187687 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index da4e371d1f9..19c6c955784 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index bb8c3de0464..f673d4ebe67 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 1c3700e8777..cadd3c880da 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index 6795b9d8bbc..ef805ab5a47 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index f1e4176222c..2fe236a6f68 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.mdx index 3a6018906da..632fc594d4e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a7327e44e85..f048a7a8335 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 0bfdbf04e73..db85991aab9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.mdx index 6bd56bc19e6..35b5c9fdf05 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.mdx index fc18de875f7..e4c10595f35 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # Gradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.mdx index 009e7db36c6..e44c2be84fd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # GradientBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.mdx index 5752da18ad7..e63aad1202c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # Hessian - + Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.mdx index 00a946d2f99..56c66197221 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # HessianBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.mdx index f7ca7efcc59..850e9b1cd22 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.mdx index 1aad7ff4fad..c17ed5bbdf9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # QFI - + Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). @@ -70,7 +70,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.mdx index aa6f14122df..8e6619bc01c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # QFIBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index 7ae719f1b69..ad1c096634c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # LegacyBaseOperator - + Bases: `abc.ABC` Operators relevant for quantum applications. @@ -19,41 +19,41 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 7ac3f7afa7b..8de3f523e9e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # MatrixOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.mdx index 4d7d389194f..d43bc0ab342 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # PauliGraph - + Bases: `object` Pauli Graph. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index 424b0158386..8a450ff0dca 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # TPBGroupedWeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` TPB Grouped Weighted Pauli Operator @@ -246,7 +246,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -281,7 +281,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -427,7 +427,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -495,7 +495,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 9affe5f72cb..e12842aca91 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # WeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Weighted Pauli Operator @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index 5d900e25ac2..129cdcb1c31 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.mdx index ce01ab9dd91..67721bf3695 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.mdx index 45b52c955eb..cf42d2f9e48 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # ListOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.mdx index 341158f2a21..a27638803c1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # SummedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.mdx index 07abb514ca3..7d3ba79de8d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index fae608410e2..70667b867bd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index cc0f9e32acc..4e034c91803 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index 041a8c01567..d45a822f6bd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index dcba818f021..d2f8e6dde9c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index 61a7259a3b9..bb5714becf9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index e94241c69df..45248c10242 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.mdx index ad8040977a0..7feeca20e57 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 16fe296b89b..4a4e01fdfb3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.mdx index ed74b7583dc..5437497d9f6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # StateFn - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 30e10867f00..4c0c59406e8 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.mdx index d7f8dbdc4fa..ecc044c4948 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # CircuitFactory - + Bases: `abc.ABC` Base class for CircuitFactories @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.mdx index f1aa3759ed7..4abcc24e492 100644 --- a/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.mdx index 14b70f34e1b..0e69b3e1327 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # BosonicOperator - + Bases: `object` A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.mdx index 755645ff9e0..a2531481b19 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # FermionicOperator - + Bases: `object` A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.mdx index aaef115478c..7d69301eef0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # MP2Info - + Bases: `object` A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.mdx index 929578ad262..614e61aa471 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # QMolecule - + Bases: `object` Molecule data class containing driver result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.QMolecule ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ## Attributes diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.mdx index b71c74d9119..3152d6d8689 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.mdx index 76981917a3a..f7c6c8d4039 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # WatsonHamiltonian - + Bases: `object` Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.mdx index 7d59ab47203..d6254e5bfeb 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # AdaptVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.mdx index e2dbdd024c6..6bf04ba3ec8 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 7acf3e6d4e5..49fb5b86b42 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # EigensolverFactory - + Bases: `abc.ABC` A factory to construct a eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index a0662dd68b0..5054491f56f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # ExcitedStatesEigensolver - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 027fa1147f3..a8b9598a9d0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # ExcitedStatesSolver - + Bases: `abc.ABC` The excited states calculation interface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index b9b6ad6443d..4a910e2152d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # GroundStateEigensolver - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.mdx index 3267792eda6..b7ccf1d806a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # GroundStateSolver - + Bases: `abc.ABC` The ground state calculation interface @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index 8331af81f9e..8648cfeb832 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # MinimumEigensolverFactory - + Bases: `abc.ABC` A factory to construct a minimum eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index 8dc4c0de270..d13cc425e53 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # NumPyEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index e89fb1a8975..45e182fe353 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # NumPyMinimumEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index 0dc46d97840..9d0f0952027 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # OrbitalOptimizationVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.mdx index d92b8179a2c..03c18ce3b96 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # QEOM - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.mdx index 78a74d31efd..5aff9c4972b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # QEomEE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` QEomEE algorithm (classical) @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.mdx index 2eb99aada68..d5857a50e93 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # QEomVQE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` QEomVQE algorithm @@ -223,7 +223,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.mdx index 54dc2ad2973..74d85b7a88c 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # VQEAdapt - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 8fca437e6a9..d4a06ddeaa7 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # VQEUCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index a63b36a8272..2c6ed355267 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # VQEUVCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 0b390840a9c..bd5d4b229bf 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index a683fa04370..c0dc669f3c9 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # DifferentialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 27e410e16ff..b7275963137 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # EnergySurface1DSpline - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 25f70a61af8..3525e0c6eeb 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # EnergySurfaceBase - + Bases: `abc.ABC` Class to hold a potential energy surface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 8de6427da62..1de65277293 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # Extrapolator - + Bases: `abc.ABC` This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index a0206544ee6..25f9ed9bcff 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # HarmonicPotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Harmonic potential. @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 5015706a5f2..c902bd422a1 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # MorsePotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Morse potential. @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 615e12be689..ecf635421eb 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # PCAExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index a3a29eb223e..27a27dae52f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # PolynomialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 51dd046f4ec..c65d6156956 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # PotentialBase - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index aff661e9ed8..052e9f0b416 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # SieveExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index b815a63e469..d3370db7f4a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # VibronicStructureBase - + Bases: `abc.ABC` Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 171d29acd52..a7adb5d18a6 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # WindowExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index a2fda7467db..269402d4ade 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # MolecularGroundStateEnergy - + Bases: `object` Molecular ground state energy chemistry application @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 12b0e129750..b4cb06bf40d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # BosonicBasis - + Bases: `object` Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 21f29c60ca5..4d704c7766a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # HarmonicBasis - + Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0477a2e77de..2ca5a0596e4 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # HartreeFock - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.mdx index ad1d3a4b809..e1a82a2acca 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # VSCF - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.mdx index 0069a69dce6..e94b20d9231 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # CHC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is the Compact Heuristic for Chemistry. @@ -57,13 +57,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.mdx index d766d177baf..f55983c9e8f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # UCCSD - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -133,13 +133,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -242,7 +242,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.mdx index c562d5ba4f0..ced5cd3749b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # UVCC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. @@ -29,7 +29,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -92,13 +92,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.mdx index f3b5d34f829..26ce880b1b6 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # ChemistryOperator - + Bases: `abc.ABC` Base class for ChemistryOperator. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.mdx index c3d02503c31..8b77571600f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # Hamiltonian - + Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.mdx index de6c15fb604..2b7a47f7d00 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # MolecularChemistryResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Molecular chemistry Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 28e1b45db45..d19d2e6800b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # MolecularExcitedStatesResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Excited States Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.mdx index ed8e6534764..2d9ffbe9404 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # MolecularGroundStateResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Ground State Energy Result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.mdx index 666348dcaf4..78f73393146 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # QubitMappingType - + Bases: `enum.Enum` QubitMappingType enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.mdx index 9392f1f0b1f..5abc45e71b5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # TransformationType - + Bases: `enum.Enum` Transformation Type enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.mdx index 7c6c9ab9cfc..4747a964ac0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # BaseDriver - + Bases: `abc.ABC` Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.mdx index a7db32a28f3..073f583e8d1 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # BasisType - + Bases: `enum.Enum` Basis Type diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.mdx index aff1c967000..868bbee07c2 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # BosonicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry bosonic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 1216408cf01..599da6276eb 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # FCIDumpDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an FCIDump file. @@ -34,7 +34,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.mdx index e9f6b72ef12..2c42a3f2938 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # FermionicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry fermionic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.mdx index 5943db9b76d..0640d92fc2e 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # GaussianDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index 85a7aecafed..7c8678b3ba7 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # GaussianForcesDriver - + Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 4ad402137c9..b42232db85d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # GaussianLogDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.mdx index 08aa4bcfdff..9d9e7705241 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # GaussianLogResult - + Bases: `object` Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.mdx index b1bfd83ed76..2983f4b353e 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # HDF5Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.mdx index dc08dc847e3..162b3eb2516 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # HFMethodType - + Bases: `enum.Enum` HFMethodType Enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.mdx index 08a7733eeec..c9820ee0f8f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # InitialGuess - + Bases: `enum.Enum` Initial Guess Enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.mdx index a36d0286020..2acdd987aaa 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # Molecule - + Bases: `object` Driver-independent Molecule definition. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.mdx index 5c6813a19cb..aedb8e779b4 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # PSI4Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.mdx index 97894cf400b..926f0304864 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # PyQuanteDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.mdx index 362eeb690e9..a5ee29a3b09 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # PySCFDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.mdx index b66a5973b75..23b7a5bae69 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # UnitsType - + Bases: `enum.Enum` Units Type Enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.mdx index d5bff92b6b0..75f25624bb0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # BOPESSamplerResult - + Bases: `object` The BOPES Sampler result diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.mdx index 8d6bc9c45be..1524ed59c22 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # EigenstateResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` The eigenstate result interface. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.mdx index ce464992806..9ad2a642d9d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # ElectronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The electronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.mdx index 12a0c43f6e0..ead9f5c13f4 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # VibronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The vibronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 02f6d520c2b..4a289e1ef83 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # BosonicQubitMappingType - + Bases: `enum.Enum` BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.mdx index 080a2134680..44dd5f5c967 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # BosonicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.mdx index ab2a11023aa..12e20b37cf5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # BosonicTransformationType - + Bases: `enum.Enum` BosonicTransformationType enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index c6edc0b9f8e..ff4e023ff8b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # FermionicQubitMappingType - + Bases: `enum.Enum` FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.mdx index 9350be4572c..b14ecf68ea8 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # FermionicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.mdx index 6057596e1f1..32242e07ede 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # FermionicTransformationType - + Bases: `enum.Enum` Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.mdx index 111d61a35ad..e74bb582df2 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # Transformation - + Bases: `abc.ABC` Base class for transformation to qubit operators for chemistry problems @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.mdx index e60f961a777..e47582ab82b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.mdx index 9e027ef7a14..155d16095cc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.mdx index 2cd323170ec..ee67c6dbbb2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Clbit.mdx index 8742163072d..2408d0c4582 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.mdx index b3ca1f4682d..6be7c042a27 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Delay.mdx index e43ee362cb9..9256f3dcff1 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.mdx index 651d72bda11..816820911ab 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Gate.mdx index 77f20409a2f..e3bb4de81e8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Instruction.mdx index 623dffe5d2e..c10723365bc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.mdx index 1b7ccd3f0d3..cd4813aa260 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Measure.mdx index da8cad9d7a2..bafd07ccd01 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Parameter.mdx index d7e431a9f44..f9589202387 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.mdx index 651174034d8..47bbf312381 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.mdx index 841f8fa7ea9..09dc0d53847 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.mdx index 9d3ea493a0a..e9881e34089 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -340,13 +340,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -762,7 +762,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -780,7 +780,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.mdx index 7d2c607e976..d6bdc91fd07 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Qubit.mdx index 93f7ea5dc0f..cf400cfe296 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.30/qiskit.circuit.Reset.mdx index c685f9c77a8..fbf9b90ccd7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 8bcbf85ae5f..32565987ed0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 2f0d39e7816..5f28d3fd55b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index c5f63a79721..8746dfcea75 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 68e24fb0a52..1c216593b03 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.AND.mdx index aae6d1662da..08c3368aede 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.mdx index 5ec7657d560..10ed222937d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.mdx index 471b65e9eaa..e123f194577 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.mdx index 068492e37b1..666c938d95a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.mdx index ff67e0fb9cb..b1f9f816f80 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.mdx index 2a81088aa70..17cd9845d20 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index d120d3e0db9..c4f9d926524 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.mdx index 97b16435712..bf6c0da7a96 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.mdx index 6cebdde31dc..d52a658510c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.mdx index bd2447ddf5c..ab0bc1546df 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.mdx index 8b83153fa3d..a86a9329f07 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.mdx index 89064272392..f8f7814144a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.mdx index 00737bd9d36..082e5838b5f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.mdx index cd20a5736fa..211d99aa74d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.mdx index ae6885f5be0..40672693ada 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.mdx index e49b6e7c11f..16deee0f985 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.mdx index 612d0d89207..7459bb2291a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.mdx index 0f8eb3e9b60..7c63ea96316 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.mdx index 428538007fe..ae7f4cd903e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.mdx index ff804eedc5c..6a34cd3cfe2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.mdx index 733ae6e1174..6150234bdf4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.mdx index 1bad671175d..21888cd13e1 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.mdx index eb2b8f5ce77..92c71676148 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.mdx index 3e8e9d89928..4c6c5e3806d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.mdx index 81befc09631..035079ea0fe 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index e4cb2e7a4d9..408c134706d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.mdx index 528cb5941b4..61fc022081b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.mdx index 281d6a53ad3..031344a660d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.mdx index c9fb976b93e..721b89664e8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.mdx index 2aa3a21728f..9deb3192ef8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GR.mdx index 3d35154102c..71bc9a838e8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.mdx index be85fb70614..ce7ee8030a0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.mdx index 6a8539d7213..1e57f686328 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.mdx index 7b45706325f..f81a261f956 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.mdx index 9a0a8d4fa1b..eadfe9250cc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.mdx index e64f9455368..5334bb15cb7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.mdx index 4e7be8b3485..fc616994cee 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index c712a8b1ca2..cc6f25936bd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.mdx index d1fa5bc1a04..dc68b0ad37e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.mdx index bbe9cd36e7c..daecfc664c6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.mdx index 5701424800a..dc744549de8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.mdx index 4d4155bc246..eca93ad60f3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.mdx index 608168ff59c..7d602c274e5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.mdx index e3dd9e3f0d3..634d578d7a5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.mdx index 7a1eb0cdb05..59417e3e4bd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.mdx index 6ad70a48e7e..81592cfa921 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.mdx index 7209542a00f..1b1576d5e9d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.mdx index aae13bd190e..50662cbe4a3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.mdx index 10bd3fc657f..636244be9fc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.mdx index 8aee00f1a45..ef62d61bb74 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.mdx index 139c6d4cb8a..0aef8882f4e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.mdx index 83de799f5c7..0a25b85a0de 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.mdx index e236d61fcf0..8403196e4d8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.mdx index 1d5dc918cb9..6c46c743963 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.mdx index 5fc86d31022..dc2c6961452 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.mdx index 3f629df8ab9..20f6fefa821 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.mdx index 77bb89c4c35..ee329f61bb8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # NormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.OR.mdx index c6bebd0214b..5862a0b52ac 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.mdx index a3344152d4b..dab5273262b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.mdx index 41cc1f8a31c..6c26563d6c9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.mdx index c74fc599567..daac5d40a87 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.mdx index cb45973925e..dc386d86dac 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.mdx index 536082ceb6d..1b3a979a99b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.mdx index 1e1f5fe65aa..b6696b68f9e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.mdx index 4ce585eb7a2..ef39cdfd5d8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.mdx index 6ffcd4b8c58..45f3708b1e4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 7869b940f22..7b195724d43 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 6b8ec05bb79..34e828e2f3f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.mdx index 8d2108ee68e..ae353d11676 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.mdx index 5001376e2b7..ac6b6ef75c7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.mdx index 7d172a9c0d5..79b9f3aa65c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.mdx index 10d6a1992ad..2516d78e22b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.mdx index dc96768bc6b..0fcca676991 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.mdx index e765a279443..0db3a0f9e2b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.mdx index 1735b1b0e90..963ac994d72 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.mdx index 145e1a19d88..d28a5bc44fb 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.mdx index febbde25953..486941396dd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.mdx index 4e387b6353a..cf5f45608ef 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.mdx index f37a6592f72..de8afd18c2c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.mdx index a4ce87e1bc7..d0906b419f3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.mdx index 5fcfa9cd0ed..4c06fd205ac 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.mdx index a44258ef907..6e8e8d56282 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.mdx index 4fa70db923b..512e12e89a0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.mdx index af89584b29c..c1260d87b78 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.mdx index 7e51b7670c6..3a796a0a655 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.mdx index 704c0d7ba04..b03a3e1f4c2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.mdx index 3eef29d039d..7d80ece1a58 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.mdx index 63188080383..458f10b1f10 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.mdx index aab13bfa833..b4889a59440 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.mdx index df31e9a2384..14eb9de8c51 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.mdx index e3e0e5626c5..e10f453cba7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.mdx index a9011593cd3..9cab7c51fd8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.mdx index a1f033cc5aa..7eef8140bb3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.mdx index 5718062f000..90e6226eff3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.mdx index 8bfc12282f6..2f7a8e08058 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.mdx index 1ac3846ca02..3e67dfd31ac 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.mdx index 9b88878b07c..495b2e00c43 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.mdx index 4074cf925a3..95252b4175a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.mdx index ee8b10cc227..a2735f93635 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.mdx index 5335f5df3f2..f436b5c3122 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # UniformDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.mdx index a64b8bdb714..7c4d1d57d2d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.mdx index 0dcfe94e82d..36497bbe0e4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.mdx index 42b392fdb1d..460485d15ed 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.mdx index ac3957934e3..0e7ddc697b5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.mdx index fbbc51ee788..f7fad5ed841 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.mdx index bc889bd5caa..463fac676c1 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.mdx index 2f7edd290e0..4f0c40184c2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.mdx index 75aa982bf0f..705e7880612 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.mdx index ef7aa70fb20..455b12f2a95 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.mdx index 41c943cb863..bc021697fd1 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -257,7 +257,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.mdx index 74f1ba48a24..011f90528ed 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.mdx index 83e4ac1a1d4..f7d2cc4e0b8 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.mdx index 2cb2674edfd..60b0855825c 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.mdx index 838039d329f..61c5a3da024 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Object to represent the information at a node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.mdx index 3fb3afe478c..8bdaa059049 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.30/qiskit.extensions.Initialize.mdx index 2f3978fe2dd..8ad775b6a7b 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.30/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.mdx index f62fefcea9d..7c4483b3fa3 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.mdx index e8882b47179..86f03620389 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.mdx index 7bb360e35a2..36e35864bdf 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 9f1837295fc..2d456d2c7ac 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # EuropeanCallDelta - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Delta. diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index cfaab07cd5a..1f4c494db7d 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # EuropeanCallExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index fd50bef69be..6e98b4e9cca 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # FixedIncomeExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.mdx index 7ab21f7e4b2..e85a4d89430 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # BaseDataProvider - + Bases: `abc.ABC` The abstract base class for data\_provider modules within Qiskit’s finance module. @@ -121,7 +121,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.mdx index d9d6253096a..d8110b835e2 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # DataOnDemandProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.mdx index a4e6691270f..389c570e825 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # ExchangeDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Exchange data provider. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.mdx index fc5d311e67d..a1c4aca6fdd 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # RandomDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.mdx index dd09960bba9..824586df72d 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # StockMarket - + Bases: `enum.Enum` Stock Market enum diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 6ef858ed112..770eb99bcb0 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # WikipediaDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Wikipedia data provider. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.mdx index 9b794c8d7f8..b9ec38bc96e 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # YahooDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Yahoo data provider. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.mdx index cd05419fed3..05559c16c31 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.mdx index 35c8a1f8cda..cb92ec9c3b1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.mdx index e2a89865c05..e4c187fc67e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.mdx index 471990a07c3..7fc9bf54c70 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 2cb64c711ed..907ea65daa7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.mdx index 796c8ad4114..cba2388ba9a 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.mdx index d48de97f326..dbcf94e40b7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.mdx index d9f67871d54..7bd3b0e303b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.mdx index 78d0b83b466..d807ec2f107 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.mdx index 96080ca5386..5ef118f9af9 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.mdx index 9d2427a8ffe..0a72032970b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.mdx index 26dc2c9fa22..82c89cffd5d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.mdx index 37b8b831ae2..9bbcb2f8e2b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.mdx index c0fb4f02719..1d904cf6d1f 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.mdx index 4c32dcdd7ab..6ba1b091dbb 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.mdx index 4b68060ec45..6a25583bf86 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index a618b199d11..161b844ccc0 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 478ad70845e..5aeff445ff1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index ff2dbb2f975..6fdbc42bfa7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index eef37cc454a..c46b2f5c2fc 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 8048a03f161..41360446c85 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 047b5fb7e9b..dc5f46377c6 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 1d4689c9640..a88584c6401 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 378183cec6f..12fe0816a7d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.mdx index c87a2d0c724..40f693d31d1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index b10b5ddb96e..0f8fb908ad5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.mdx index 640f0f02bde..ce42be2f0c3 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 54a4c0a6834..69caa71c49e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.mdx index dd4034ae2ff..355df13ef86 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.mdx index 43306903dd2..96b8c74f4d2 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.mdx index 1472cd43dbd..94622b107aa 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.mdx index 41ef30dd784..20201b456b7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index c24f99de034..96eeb848007 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.mdx index b90f47dbf0c..1ce31cc35c4 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.mdx index af9c13ef001..f9cda6c23ee 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.mdx index 3d69f841152..fcb8721075c 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.mdx index 90f03443e78..6ffe80939ea 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.mdx index d3c3debf0cd..711f5553506 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.mdx index 2ae6db88219..2adfadd93f8 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.mdx index 7f291d2d3ab..e95ddfe13f2 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.mdx index a7f21ebbf32..d2548d72895 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.mdx index cfd9db2f212..c1640cd317e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.mdx index 8f3f0e35819..2025a3632d3 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.mdx index 222e4029b77..7698bd99556 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.mdx index 67f24664aba..e2edd80e141 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The raw feature vector circuit. @@ -128,7 +128,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -164,13 +164,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -586,7 +586,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -604,7 +604,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.mdx index 38d34b8c4df..149f4da528a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -207,7 +207,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -253,7 +253,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -271,7 +271,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.mdx index 69c8f8acafe..dd70307cb72 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.mdx index 06b358eb294..27943a01229 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.mdx index 09d211423d7..a14f211dacf 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.mdx index a1f404e66b6..d103f696cbd 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.mdx index 2febdbcdc38..abe43a3e1ab 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.mdx index 3e7b05568cf..89f3698a1b7 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.mdx index a2f9bc6ab12..1c6277cf6d9 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.mdx index 62e25e5412e..91bb9242c96 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.mdx index edb1f84d31d..4672e9e401e 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.mdx index 05af3b167a5..e6df4af3f09 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.mdx index 71d69092bd9..8b40ab664bb 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 6dac1bf3e20..0b8fe14fa33 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.mdx index 7ae4eed0cad..cd627826f11 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.mdx index 4bac8192c57..0d488be1b0c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.mdx index f19c6dedf5a..21699813034 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.mdx index d079c7dd33d..e314c4fc169 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.mdx index ce855140e8d..2601f58f901 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.mdx index 4aae59be22e..8e217c67c77 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.mdx index 6980e6d35d2..fc28ef6e490 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.mdx index 3bed350ae77..d75ae9f84f2 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.mdx index b0113af7825..341e9b4bdaa 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.mdx index 12acacdcaf7..ddad236dc9c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.mdx index e13e6fc2334..f8e0180659c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.mdx index 703b3aaeb23..4a8d87ccdf6 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.mdx index bd0311e7447..49a214c9a5b 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.mdx index 64aeb6d9cb8..5564b3d7f76 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.mdx index 0fc3150a6db..b3b61f5b5d1 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.mdx index a7e6e41a3b7..72a2c8000af 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.mdx index 4e19960c313..657d9e11304 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.mdx index 6ae5d1076cd..30e6dde2580 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.mdx index 79bceb8ff81..5deb277c4be 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.mdx index d4e81349854..78ab225933f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.mdx index 8223f03d774..9fc0b7412df 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.mdx index cb8494bf088..af8278bcf4d 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.mdx index b68bc55be03..5786e23fbd7 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.mdx index 503f03e3a0c..6be32eaa7c9 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.mdx index bf50c72e85f..06811dc1c54 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.mdx index e997228c2d8..d479c1d1de7 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.mdx index 394fccc90ab..e102b212a82 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.mdx index a266dfe0bbc..0a86648c03f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 53af0f3650c..e848d4068db 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backend by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index a3be025a6cd..e434d9ceb5f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 72b3f09afaa..ed3fa6516ee 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index da8ae03d781..1e18b9e151a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.mdx index ab08acd1f26..1eaf5b5fb9a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.mdx index 0bfffd6d323..b6b630d8622 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.mdx index bb30f9f1f3c..c0d39647960 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.mdx index b0a37588316..7edc0986e2a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index e0a6fd4b332..6b67ad6964f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.mdx index 5af81f4c8c6..75fc14d028c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.mdx index 3559ebab3ec..19969315164 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.mdx index 5a3c246fcfe..da2d10c2205 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.mdx index f91cf3e8057..37b7c663f62 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 51bef8ac0f3..dceed501e26 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # ADMMOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` ADMMOptimization Result. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 5208dfcc02f..79a48670ae4 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # ADMMOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.mdx index 77872f382be..692c38c30d5 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # ADMMParameters - + Bases: `object` Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.mdx index 40d6017d6fc..d6028e94257 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # ADMMState - + Bases: `object` Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.mdx index ea5943c1a0c..3430d5be0cb 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # CobylaOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.mdx index 227e3cca202..8bfe276e2d7 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # CplexOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -78,7 +78,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index d78d9e123c8..56ed0bd1297 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # GroverOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.mdx index c219cd129d1..70abc2b2200 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # GroverOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.mdx index 971f2fe4fc1..fcb45add97a 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # IntermediateResult - + Bases: `enum.Enum` Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 69b81353b66..329d902f358 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # MinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index c81a65e4e0d..26221a7b870 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # MinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 975756bf3a2..d7b755212ad 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # MultiStartOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` An abstract class that implements multi start optimization and should be sub-classed by other optimizers. @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index ba9d9e23142..4a55a766f83 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # OptimizationAlgorithm - + Bases: `abc.ABC` An abstract class for optimization algorithms in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.mdx index 0cddaaf87f0..2fd25e78252 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # OptimizationResult - + Bases: `object` A base class for optimization results. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index 69057e9376e..e74eb11bd7b 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # OptimizationResultStatus - + Bases: `enum.Enum` Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 616b8f64191..3dee30e4fa4 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # RecursiveMinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index 6333eedba90..d0252360631 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # RecursiveMinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index e18a64f6263..9aa5efdf8c9 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # SlsqpOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index b08d49889fe..a42fb7f32f0 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # SlsqpOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.mdx index a8f260f993a..3cb785a2b39 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # SolutionSample - + Bases: `object` A sample of an optimization solution diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.mdx index cf48c3a499a..03dded7cc15 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # InequalityToEquality - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.mdx index da4d1c5a0d3..db9b19e4920 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # IntegerToBinary - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index c68ef9a78fb..47597b8cc71 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # LinearEqualityToPenalty - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 4768a441cb3..4cfbd2cad5e 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # QuadraticProgramConverter - + Bases: `abc.ABC` An abstract class for converters of quadratic programs in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index 14232d52624..76c36b0b3b7 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # QuadraticProgramToQubo - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a given optimization problem to a new problem that is a QUBO. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.mdx index 62dc54b369c..9a07e8e12e5 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # Constraint - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Abstract Constraint Class. @@ -26,7 +26,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.mdx index 6ab377f4fd8..687e040c0cc 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # LinearConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a linear constraint. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.mdx index 25c1c8a747d..76733cff526 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # LinearExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.mdx index 047bb47877c..1a56fe27952 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # QuadraticConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.mdx index 82dc22dda07..e593560cdcb 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # QuadraticExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.mdx index 3e44d3e0e65..170ea1222c8 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # QuadraticObjective - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.mdx index c8ba5b87a39..c3a0e312d1c 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.mdx index 6541045e346..99f1d864f19 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # QuadraticProgramElement - + Bases: `object` Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.mdx index de3b48f2933..28ab69d31fd 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # Variable - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a variable. diff --git a/docs/api/qiskit/0.30/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.30/qiskit.providers.Backend.mdx index da3a7652b55..5e05195f14c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.mdx index f69330f7c6b..72a40076aab 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.30/qiskit.providers.BackendV1.mdx index bd36632dc3a..f8006dd85c3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.mdx index b16a7eb6418..b5cbfd97b58 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.BaseJob.mdx index c9c50736acb..d4d52ea1329 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.mdx index 82bcb368239..215c5de8291 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.Job.mdx b/docs/api/qiskit/0.30/qiskit.providers.Job.mdx index 54ecc0c89b3..6508be69518 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.30/qiskit.providers.JobError.mdx index e0b4465d8da..9288a244b73 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.30/qiskit.providers.JobStatus.mdx index 26d97f65d9f..21cece14df9 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.mdx index 0662d1b43b0..3034325f70d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.30/qiskit.providers.JobV1.mdx index e696713dfec..19f7a2ac088 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.30/qiskit.providers.Options.mdx b/docs/api/qiskit/0.30/qiskit.providers.Options.mdx index 30143726dce..e2a64db46ab 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `types.SimpleNamespace` Base options object diff --git a/docs/api/qiskit/0.30/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.30/qiskit.providers.Provider.mdx index a1e4820a314..41a8286de36 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.mdx index ccd9e916034..9f6a4375441 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.mdx index c9eed91c692..c8399f862b8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.mdx index f5d45324e73..f86276b2b55 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.mdx index b0f97a7b4b5..9b6b15cd19d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.mdx index 90e9f3b09ab..0070570bfb7 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -205,7 +205,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.mdx index 39b6b410f58..3bb0292b6c2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.mdx index 5091f61cae7..9d727bb3509 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -184,7 +184,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.mdx index e1deda88448..d79a5cbc884 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.mdx index af36737f947..4de66c199e2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.mdx index 55f3fecd6ee..75c584658eb 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -92,7 +92,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 956dc81fa78..032ff2abb66 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index e6ba2e0b979..7b3b9bd0e30 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 45484f453a9..be630210442 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -90,7 +90,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 3fa086b7f9f..f5ed53ce05c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 035119c2653..c0493cab342 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.mdx index e8d0f031bd3..447011556f7 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.mdx index 0b968f7c1d0..35fface0455 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.mdx index 4b3c327f2b5..13c5db051f2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 85eadc1d527..fbceab7db97 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 687c86423d2..b5cd3012899 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.mdx index d8e93822c50..cf0e9be7f3d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index bf8b482a55a..c731e70a1ae 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.mdx index 0d3d5fb38e0..d75cf11c4a5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.mdx index c5fbc3073b7..da2d0dd18f2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index e9910051e9f..0bc92eb7fad 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.mdx index 9919d798541..fb243b689e1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.mdx index ca0424db96c..d6ac2638997 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.mdx index 2c09133118d..3728e10f193 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 625d7138068..54df40d0906 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.mdx index 4e282a0fdac..7d24905be18 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.mdx index f8a9573ca3f..fa3adb49c42 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.mdx index 66727e2448a..a3524b1ea67 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.mdx index 2f707161b99..96b835afea5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.mdx index d3182a6f85f..2aac219d97f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.mdx index 36f8e6b3971..10a18500db1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.mdx index 0e98c4261df..40566ada3d1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.mdx index ca5dd902eab..52045e58a17 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.mdx index f42e7bf27b0..dac95973dcd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.mdx index a5c7ee1c806..a0219f8d41b 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `object` Quantum error class for Qiskit Aer noise model @@ -180,13 +180,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.mdx index d8f483dbd02..6ab625de8c6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -153,13 +153,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 5d1fec56e1e..b6ec7e26958 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.mdx index 077844871bd..7fcfa708655 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.mdx index bd5d2c2b441..1d4d1312c2e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.mdx index a2c3bb842db..34e53bdba4e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.mdx index de74083a1a2..b37d065031f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9314006cf7d..78f741cd891 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 43cd26238a7..f6e9ed4ae0a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index e1c871e48d8..e7433a01f51 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.mdx index 87a58ecddbf..deef86d86a8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.mdx index acf7dea13c2..1cef34ddd06 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 9f7b11f9bbb..a267a303dbf 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 4b3dd0bd123..50454b6b26f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 4656c7eefc3..9e2e8720a26 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7593827c51a..992e51a1589 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.mdx index 4f9a2d49865..f92400576e0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 4968bed2f56..889f66c21b2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.mdx index d265c048249..df3470f0efd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 7e1eb2366ee..ddc11bf97d5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 8918b3c15a8..ed5f8d51bf9 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.mdx index 517715fb1c2..0350c1bce44 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.mdx index f9a6d262a38..f888462755d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.mdx index ee3eed7c1c2..2374fe7de65 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.mdx index 6d35caa9a69..0eaa2ed217a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.mdx index a5a2f6905cd..dc543bf8d88 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.mdx index d2ba98d03f6..32c56b54ca6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.mdx index 5fb913d2d5c..9fef217e121 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.mdx index 383bd2f3f75..335246f0a97 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 66ca122f221..a32773ba5b5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index d11d8f07f1e..56f780baad4 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 56fbe15d9db..90f3853d80f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 7a1e93d5891..cae73401c50 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 748a02f8580..975448f76d9 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index f8f4969f0c4..64d51bab2d8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 25c3c7e1c85..861556e84de 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 1cf456260a9..85bc469a6a6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.mdx index 256373bbd02..2f2dd5526c4 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.mdx index d43fda4ad52..d35f097bab0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 2c4efd86fb2..4c8f9aa4bd8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.mdx index 658e6ec1259..20fb28a3214 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a8467f23800..b5996b8d424 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 6ad91c98487..3ba4abed37e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index c77033d74fb..43583364dd9 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.mdx index 9e4043abf60..1a5a825b8a8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index cc674639cfc..0e267eca043 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 9642182f19b..723eaff7389 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 8868100c4c8..79146ebef7c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index ad1a0bd4c76..ac7f806b57d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index d42e6a07c18..42b25be1d2c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 7b7f7f8e817..a04946795f1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 812804215cf..185a3c90a5d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.mdx index 7497279fed6..effecb25df3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 7e993f34650..715b4c0bc91 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.mdx index 1ab5a4bb31c..fd68c2f7c69 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.mdx index 9437c784cc1..8ce5d306113 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index d12c8a28b30..94f3a4d8759 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 799e5f0e5e4..e6bfec0c66e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index e57fe4c0fa0..908034b4ed5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index e43d5d1a885..c3a81a8700a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index ee7fae87595..33bce80fc6c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 8f8f9271552..60c3d87a083 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index 7a6b8882150..6c3f4f7cd6f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 44efd236de2..ff3c6dd43e6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 5adb8cb9e1d..86f72b5561a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index de2c2bd43cd..16e12dda171 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 9a7a43c6c97..0d801476850 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.mdx index df3eec4af33..e918da4236c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.mdx index 77d1fdc8179..1c4bde79839 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.mdx index 21e87bf2375..721c21747af 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.Command.mdx index 16a2ea5505e..50cd1f6bf55 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.mdx index 13586a9d476..de60478e5a6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.mdx index cb44704c9f2..47616218175 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.mdx index 237830bbcb9..7e6ba952bd2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.mdx index f94da9524c7..ec2aa302e11 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.mdx index af5fb36db89..9c26f781764 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.mdx index 007d38dcc2a..6c09d232fda 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Acquire.mdx index c46affcf243..eaeab81591a 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.mdx index 3b4390572c3..c5d06bd8ed0 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # AcquireChannel - + Bases: `qiskit.pulse.channels.Channel` Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Call.mdx index f151ba8efd1..47fb7c293de 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Constant.mdx index 03b3cf4f08c..0f0be66e7b3 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.mdx index d3d4550a91a..03b83c73efa 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Delay.mdx index 6274766068b..72ede7938b6 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Drag.mdx index d641be206ca..69cfb7778df 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.mdx index b0c081287e1..6342fe06263 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.mdx index 7239447283c..e3140a854d3 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.mdx index b7627fb089a..edf5e9e1848 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Instruction.mdx index 12dcbd180c2..7887bd36a08 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.mdx index 34ab0f5aba0..97d2b9a6ae5 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.mdx index 2406d6ddad0..5ffae39cddf 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.mdx index ed27d7e5171..a1667df5ff0 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.Channel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Play.mdx index e1d51dadbcc..72d5412bab9 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.30/qiskit.pulse.PulseError.mdx index ca8a63aae19..6c4a5209ca4 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.mdx index 8b413549bda..22d9d2534cf 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.Channel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Schedule.mdx index 140ab9fc9f2..1c77775f356 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -296,7 +296,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.mdx index 8b97bfbb906..88da85b43ff 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -295,7 +295,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.mdx index 8fb5f108629..c3335f82fa3 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.mdx index 3e5d6200fde..de3cdce12bb 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.mdx index 93e46a07f22..9c9c766c12f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.mdx index fb79ac431eb..75edfdeaf40 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.mdx index 90858c62fda..5db8a3ef85f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.30/qiskit.pulse.Waveform.mdx index 780d837b6f8..9af0eb34e13 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.mdx index 0abccea3dab..501f81b2380 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.mdx index d639c707f65..8cb6fc9b292 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.mdx index ea1dc87c499..ccbd34db68f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.mdx index b593356bf32..dd7c65e99d7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.mdx index 0034967f27b..8b8ea86fed1 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.mdx index 984cfc81cd8..7cec9fadecc 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.mdx index b8f649e8eb0..9edbe40b8b4 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.mdx index 1b16be0b1a9..c2d69b0cb36 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.mdx index 50892b62692..a6831d826d5 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.mdx index 6c3dd77ea24..c350a17086a 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.mdx index 4184f268ebc..52e3da88aad 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.mdx index 80b66d60df7..bf98cdf5146 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.mdx index 2c61e27b4f6..f8b4d22ee56 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.mdx index 7182421becf..1b342d82041 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.mdx index fcd2b6c9539..da3b290edef 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.mdx index ff87cec855a..6aa25cb8683 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.30/qiskit.qasm.Qasm.mdx index dfe2bc265a3..ee416b485d7 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.30/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.30/qiskit.qasm.QasmError.mdx index 1fee3b72dd5..d644aafdce6 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.mdx index 3175a24235e..8a75e46f579 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.mdx index 07db1b7f478..94b7bc6e13b 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.mdx index 787f8e54b05..8ba473f21c7 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.mdx index b0dcded88f7..961f5fbc5eb 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.mdx index 6b0bc938ddf..1de601a7622 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.mdx index d615fb5e98b..7b584800b3c 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.mdx index 7f014f78fc6..0d2e71ac736 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.mdx index ed924abb218..aef0f5c9e38 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.mdx index 0938a0f479e..7eff2daa6b1 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.mdx index 6ab7b245f1a..760936cb3be 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.mdx index 492c4cb275d..ff4d9d86086 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.mdx index 5266d26b602..d6375345104 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.mdx index 5aa7935b61b..3a9b20709a6 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.mdx index 376ce1979d4..69f33477d2f 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.mdx index 645337a5946..4670a95d788 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.30/qiskit.qobj.Qobj.mdx index d3b93718154..304342d2ccc 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.mdx index 3a4e3bb91e3..61c2b439545 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.mdx index ae6aca77470..3b48e646c30 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.mdx index f7a32cf39ac..dcf3049a9ae 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.mdx index 23558fb64bd..f1eee674849 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.mdx index 63f21af5c05..3defd7bf44e 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.mdx index 79e5803cb2a..7ab00722f55 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.mdx index 76eb29b3662..d111340e1c3 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.mdx index c8ff5f7a644..c7794c4a04b 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.mdx index f0ab29c1830..2cf7a5617cb 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index cbcc74d4a49..e5814f3fd96 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.mdx index 3aa2cc46607..f6427a78321 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.mdx index f04a63d5a70..39e99d5a841 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.mdx index e9c62f99e8d..947d1c69b25 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -335,7 +335,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -455,7 +455,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -497,7 +497,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -542,7 +542,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -556,7 +556,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.mdx index 5bf53aec4ae..6bc4fea2315 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -363,7 +363,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.mdx index daff127f2d8..620ed743660 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.mdx index 93182821c26..890fd2e73d7 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.mdx index 268a8a27469..987aa2217b8 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.mdx index 97088458d15..c7f0fe360f5 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -121,13 +121,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.mdx index 2b24f2e06f9..e017c9a2518 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.mdx index 65bd99c47d2..3dba2e3848a 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.mdx index e3f122155ac..9e9ec1833cb 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -178,7 +178,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -202,7 +202,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -228,7 +228,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.mdx index e6bae9cd6ea..0b106b77207 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.mdx index 435e5f7f66f..4a3d460e981 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 364a3315218..2306ef07ff4 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.30/qiskit.result.Counts.mdx b/docs/api/qiskit/0.30/qiskit.result.Counts.mdx index 158a1a4df8e..9b1b034e6d7 100644 --- a/docs/api/qiskit/0.30/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.30/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.mdx index 72cdecfa8a4..f6b6bfcbe5b 100644 --- a/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.mdx index 5244c68e1a8..64583f12b9d 100644 --- a/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.30/qiskit.result.Result.mdx b/docs/api/qiskit/0.30/qiskit.result.Result.mdx index 4501570076e..ef166e7a2db 100644 --- a/docs/api/qiskit/0.30/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.30/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.30/qiskit.result.ResultError.mdx index e80c051198f..9a2fb418993 100644 --- a/docs/api/qiskit/0.30/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.30/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.mdx index bceabdb134a..e8dfa7d43f6 100644 --- a/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.mdx index 0103bc72544..ba5f7702eb5 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.mdx index 665aa86e542..a685ebc5325 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -89,25 +89,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.mdx index 2dfb47712ab..552fc450f13 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.mdx index bf8cd388da6..bf46d7cb7bb 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.mdx index f3487c8d57f..afbf44b10fd 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.mdx index 4531ba5634b..d1c89542d6c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.Layout.mdx index 66dfdf1dce5..8e3a6f04683 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.mdx index dc44aadcefa..7d3750743a1 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.mdx index 0fdb65ac9b5..373ccf1770b 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.mdx index 1424acdfdf1..b78cd0675ff 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.mdx index 7454bf8f37b..83a209c7b15 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.mdx index 32abb7d32c7..f5e7ba9af8c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.mdx index 39abe7bc7fb..9eb783e480a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.mdx index 38295935694..d125742b206 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ALAP Scheduling. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.mdx index 51ceb2dfae9..3d6ff6d7001 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ASAP Scheduling. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.mdx index e293cbf19db..b54daca5578 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.mdx index 6897f1689f8..34c0da5a1e2 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.mdx index 78dad80e642..3c33be38436 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index d1fa3c2c55a..4600bbcdae9 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.mdx index 530cfa152a5..655038ed913 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.mdx index f688563cdda..83bba6c76db 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.mdx index 54cf75273fa..2ad60c74a37 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.mdx index a18492dcbfd..99943f34bbd 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.mdx index 3d66a5832ab..a54d042e870 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.mdx index 1db8bb2062d..6d4ed01da2c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.mdx index 2cb436c3808..aaa868860b1 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.mdx index bfbc0df66ea..f211a83dc2e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.mdx index fba6454cd0a..b77ba82085e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.mdx index a9b9525387c..ff1007a7e23 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.mdx index 5e26bc707ec..736f9f68af4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 2d6dd13bc91..1e3834dc7cc 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.mdx index e5fd169cc9f..df56f82a5a4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 147283b7486..735092c4c2e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 71908291200..77d3f828d3a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.mdx index 80f41d00250..77f9737e21c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.mdx index 616bc9db666..ffdbefa4bfe 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.mdx index 801dda46e8e..2148594fe22 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.mdx index 21b01bea5de..67f62e2503b 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.mdx index 51b17f3e8b1..8587a9fba15 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 3dda0280b53..3857f0730a3 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 909b96f0577..9930da83fe2 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.mdx index 3b5f740f6e8..137acd1f151 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 509f1962490..d63279ef495 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.mdx index a6011195098..d69ea681de9 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.mdx index 7d156d59295..c41c95d13d1 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.mdx index 00eed73c469..2a69348ebf7 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 6afee12337a..3c21d1749b7 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 99ceb9d7892..1aeaf747b3a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.mdx index 598751f3e13..111e4e445a1 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.mdx index 464a43468d3..1e39bc9f9c4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 37570f0c4aa..24d9a6ab333 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 561f6872895..b42550a839d 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 30991351e79..f74732a93b6 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.mdx index 0b87683ad62..6080ea54ee3 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 1f34ed4cbd9..f180dc84fee 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 84cf5091c36..d074850769c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index a58a5f616e6..9a9854be12a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.mdx index 64cce077218..0bdd1e1f7e5 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.mdx index 304378dbd1e..68e0ee75ccb 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.mdx index 3c313b4afb5..4e5ef4b3199 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.mdx index f2944f69e21..8952d6b77a8 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.mdx index dffc58a8e88..412919a680d 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.mdx index 3424dba5bce..8681fba39b0 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.mdx index b9bb9d5aa99..fdf23171eaf 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.mdx index 55ae91c577b..95c98a4fed9 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.mdx index c647c006fef..d8de9ab7ab8 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f21a57c9603..509e4c7a572 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 228d354d16d..b249d1645c6 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.mdx index 84a0c29e7b7..49f13d101cf 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.mdx index 31bb14e608a..159c8b45b11 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.mdx index 41a31e8b8fe..ad3d7baa0da 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.mdx index 52ba4d23cf8..8e24ef8fd5f 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.mdx index c37360eb77c..ee9faa63b85 100644 --- a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.mdx index 78e42abd197..0190b8691f5 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.mdx index be478fc23ef..0fa502a9d79 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.mdx index 2d1e4fca4fc..a0f25da183f 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.mdx index 090758ed8db..39ada062624 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.mdx index ccfbaad8d57..44af67d38c5 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.31/logging.mdx b/docs/api/qiskit/0.31/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.31/logging.mdx +++ b/docs/api/qiskit/0.31/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.mdx index 27bbb468033..868c57f157a 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.mdx index ce3b0f96ba6..e20a18111bd 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.mdx index 36fa8cc2aff..906c513dc64 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.mdx index 17eb1853697..5c71dedbbb1 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.mdx index 00fe5f33265..7b60153afc2 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `object` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 70509ef002c..13f297c80c3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.mdx index 70ad6b4aac9..46c071c2558 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.mdx index 87f8f9daedf..3b83d666e6a 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.mdx index b3a77b6b9db..60697f8df81 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 79e833d9e90..be857a5b9f3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 71aa0b7e804..da6299681f6 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.Grover.mdx index 354fe28d9bf..8e9bbf24037 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -126,7 +126,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.mdx index fa839512092..db3d7fda816 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.HHL.mdx index 413c35d800e..3cf7069642f 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e6952740e95..82e9e4b2275 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 726bc19ddb6..2a6c97c6a47 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 03e4a7821bd..b18257cbdd7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 48dbc87a0b1..f05969ede56 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.mdx index f0016028c22..ba6c14448cd 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.mdx index dcc0a8e1f50..e063b75d0c5 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.mdx index 4498e3ed742..68f299d8a59 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 9445f18f186..16b27061db6 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 4d84642032b..10517e02a48 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.mdx index 756ebc0587b..1e7f05b57a2 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.mdx index 4099331d509..54cb3ed1107 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.mdx index a38ebecbb7a..b608d75dd2f 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.mdx index e1ffbabdca0..9debe18386d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ebcb21aa0d8..df1cc669880 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.mdx index 5d41c8a2fd3..a53ce036318 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.mdx index 41de4387e57..e3262c9bf92 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.mdx index 258ebaef686..2471882a19a 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.mdx index 42aa86fc941..36401083742 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -215,7 +215,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.Shor.mdx index f2335ebe022..95d204d76e9 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.mdx index c3e1f75812b..ba9ef7320b6 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.VQE.mdx index d01e0a12cf6..fc32ac2d96b 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.mdx index b96c232ce64..9f31ba86c13 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.mdx index 9e2d1ea1b3d..090c58abf17 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.mdx index 7467bec47a8..af8f6e6a358 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.mdx index 11c359e84ec..4eb9d57eb3e 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.mdx index 1c93a34eefd..7de0ef061a3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.mdx index b9d9301afe8..b7271ebabba 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.mdx index 655a14df4e8..b3e3ed94133 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 354e31bc7c8..416e5ce797f 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.mdx index 9ddc42b2760..4da5c79bb4e 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.mdx index 3c0f22fb9ae..c0a001cbbb7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.mdx index 530732ff721..7e184732561 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -117,7 +117,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.mdx index 7e8c93af72b..4910f58e8ed 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.mdx index a93bb96b039..2cd15aa6907 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 61ddde0accc..c86aeef4204 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 432677ac538..1e28de32423 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx index 8fecaa95805..0d16ef55736 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.mdx index 5a0853a72b3..63ff55ed780 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 95cfd0c9224..64e5b9caea7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.mdx index 6b0d9afe1fd..66318cfcdf3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.mdx index 919c08c8b01..fcac617b5cf 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.mdx index b68593c056f..6ccd956db86 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -104,7 +104,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -114,7 +114,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -148,7 +148,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -217,7 +217,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.mdx index 8c871303961..fa7cee21549 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.mdx index a49784b3a49..325141ee691 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.mdx index 7d1895a56c3..56d78602473 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -129,7 +129,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index fefb1663818..8c9a91d5ac6 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.mdx index fcb3446be45..868194f1061 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.31/qiskit.aqua.AquaError.mdx index 1f61f9c108e..fdb9020ae4b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.mdx index 7f2568205fe..f5c6442b543 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.mdx index e7cd4f84cc3..8ca862417e3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index ae18bbc59fe..bcbbb435929 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 0daca935eeb..06e5cfab49c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # AmplitudeEstimationAlgorithmResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` AmplitudeEstimationAlgorithm Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index 8e042284a76..16ee4734a6e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` AmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.mdx index d158e777dbf..1623ad79433 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # BernsteinVazirani - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index bafd330cb94..211a42e58d2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # ClassicalAlgorithm - + Bases: `abc.ABC` Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index 7ea1864f8cf..4ee685156f7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # ClassicalCPLEX - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.mdx index bc52ede6d91..f1e863e00d0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # DeutschJozsa - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.mdx index cf4fb86247b..a8bd3cf01e9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # EOH - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.mdx index 0bd258c29e4..b1bf5d10f37 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.mdx index 6ba69c1b56a..771cae801aa 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.mdx index b691284ec7a..20c5c47ecd2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # Grover - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Grover’s Search algorithm. @@ -132,7 +132,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.mdx index 34ff167c211..22754f143d1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # GroverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Grover Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.mdx index 91b20ef5214..44a9e97400e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # HHL - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The HHL algorithm. @@ -74,7 +74,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -93,7 +93,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -112,7 +112,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.mdx index 052864ee11a..2bd1c4108e8 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # HHLResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` HHL Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.mdx index 794aaa3e056..f1b8f6bc2cb 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # IQPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Iterative Quantum Phase Estimation algorithm. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index acfc3344319..2c5cc177bbf 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index b4d4cc41f12..043cc9ca927 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` IterativeAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.mdx index d884d0798d3..cc31377928b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # LinearsolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Linear solver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 29abec34ad9..84dda7a68c6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index bf23c4e2c5a..21630a4c8c9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` MaximumLikelihoodAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 595f945114a..b5a49f30e72 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index b34c0a78193..d7c48d458c7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 66d526f91a9..97fabc6ac2d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 8f849c80ed2..a040186dd97 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # NumPyLSsolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 894372c48f6..13b32c25fb6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # NumPyLSsolverResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` Numpy LinearSystem Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7430c317278..69df9a4b40b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.mdx index a476d05a605..e80e2f5cf31 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # QAOA - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.mdx index 89844fbf513..0247d398c98 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # QGAN - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.mdx index 00ec2a39fda..2bb59eda2e7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # QPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Quantum Phase Estimation algorithm. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.mdx index b834ebe046a..46f191cc1c5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # QSVM - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Quantum SVM algorithm. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 0ba85ad92cd..f55e9a33a2a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # QuantumAlgorithm - + Bases: `abc.ABC` Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.mdx index 5e41c8e070b..2c0b77a00da 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # Shor - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Shor’s factoring algorithm. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.mdx index a0e34d193c5..f57574cfaa1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # Simon - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Simon algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.mdx index c6048af9e22..4fc369c2dc0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # SklearnSVM - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.mdx index d4fb976a730..9d3e50a3404 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # VQC - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.mdx index a2c65fb86af..fd46719101a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # VQE - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.mdx index 5bf84eaa937..cbe5430c32c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # CNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.mdx index a8a1baf02af..4ceb6aea257 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # DNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.mdx index 3c79c6e8093..ee982de53b9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # ESOP - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index abd32e1cdc0..5e74db7bb5d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # PhaseEstimationCircuit - + Bases: `object` Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.mdx index aae1333c99d..667eff19e84 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # StateVectorCircuit - + Bases: `object` Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.mdx index d5d517e89c9..ce90c018fd2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # WeightedSumOperator - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Adds q^T \* w to separate register for non-negative integer weights w. @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.mdx index 675c831dc5a..83aadbb5491 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # Eigenvalues - + Bases: `abc.ABC` Base class for eigenvalue estimation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.mdx index f8ee08c4353..867e7349794 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # EigsQPE - + Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.mdx index c3ee92ba022..abe7deed93e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # FeatureMap - + Bases: `abc.ABC` Base class for FeatureMap. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index 27b7f557148..7c89e12dabc 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` Raw Feature Vector feature map. @@ -48,13 +48,13 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.mdx index 6447c481b53..d1e18855453 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # Custom - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The custom initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.mdx index a6f130beaed..0375875d925 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # InitialState - + Bases: `abc.ABC` Base class for InitialState. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.mdx index ef0e560fb3d..895fa842fd9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # VarFormBased - + Bases: `object` The variational form based initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.mdx index 4a900516297..58397e57632 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # Zero - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 77097eaa48f..2fb87e48c22 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # AllPairs - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 2b86bad395f..5c9987ed5da 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # ErrorCorrectingCode - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 8781ea7ca25..cbd49a120ba 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # MulticlassExtension - + Bases: `abc.ABC` Base class for multiclass extension. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index d23ad79895b..38481ba0356 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # OneAgainstRest - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index ab65b051646..f6d227cfd49 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # DiscriminativeNetwork - + Bases: `abc.ABC` Base class for discriminative Quantum or Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 2d499b7cae3..cac1ab34f29 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # GenerativeNetwork - + Bases: `abc.ABC` Base class for generative Quantum and Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_discriminator - + Set discriminator network. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 3fc887bc77b..49ab5bce4f3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # NumPyDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on NumPy diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 6bf01bb0067..05eebaff1e2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # PyTorchDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index 87237b296d8..adcd045b540 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # QuantumGenerator - + Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` Quantum Generator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.mdx index 38f6182d7ec..49b16fa83c0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # ADAM - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -174,7 +174,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.mdx index e4a9969bf4d..a363ba2b977 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # AQGD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.mdx index 7946e658e48..8ce7b43d6a0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.mdx index 6ad5978091c..61747582c08 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # CG - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Conjugate Gradient optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.mdx index 24695fa91a2..a39df858920 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # COBYLA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Constrained Optimization By Linear Approximation optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.mdx index c80d56326d4..28421a7117a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # CRS - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8fe0fbb9941..1f9667b6351 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 12e9e03ca89..ec2a74e5812 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.mdx index 5fefe583b59..9e156b22bbf 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # ESCH - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.mdx index b7b984313da..5f22a8130a1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # GSLS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.mdx index 49fa6c8cab6..fc70bfd3b7b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # IMFIL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.mdx index 95a45c07256..125ba03e926 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # ISRES - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index 21af907f212..0479473c1d1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Limited-memory BFGS Bound optimizer. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index b363ba9e541..a2e75f2f8da 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nelder-Mead optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx index e8f4594a56d..e2fef891fa7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # NFT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nakanishi-Fujii-Todo algorithm. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.mdx index 2fa3469e9e7..cfd9af18e80 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 89a9711d203..f07f7589643 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.mdx index 4168ebac7c4..9b8a190e473 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # POWELL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Powell optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.mdx index 35656a9b66a..7a177a4aa99 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Parallelized Limited-memory BFGS optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.mdx index 06cc2c7f4d6..2079f7a18bc 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # SLSQP - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Sequential Least SQuares Programming optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.mdx index d1d18448d60..42cc5441e89 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.mdx index f46d3ceed8c..82ec517b53a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # SPSA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.mdx index b01ec640cb7..62c13f35160 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # TNC - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Truncated Newton (TNC) optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index 51c2f5e1f8b..4c68259fe2c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # CustomCircuitOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 80ee7dcc639..9ddc9616bdd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # LogicalExpressionOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.mdx index 39f5057a134..62e7faa0e5b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # Oracle - + Bases: `abc.ABC` Base class for oracles. @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### construct\_circuit - + Construct the oracle circuit. **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b5dc61c3e15..86be4315904 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # TruthTableOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.mdx index cce4819e748..90d09ff3d93 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # LongDivision - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.mdx index f3de6ac158c..511babc009f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # LookupRotation - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 876f8f0291f..fcfe3006f18 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # Reciprocal - + Bases: `abc.ABC` Base class for reciprocal calculation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index e768edb2794..62b51684d0e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # BernoulliDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Bernoulli Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 258208b5e7d..534f31cdd8e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # GaussianConditionalIndependenceModel - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Gaussian Conditional Independence Model for Credit Risk. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 432cd96cf0c..57cdba473a6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Log-Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index 8edeb4ad3be..33c01da171f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # MultivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 6f560d7308d..43b9eb602a5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # MultivariateLogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Log-Normal Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 44d51bf056d..f1e6753aa4d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # MultivariateNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 1608f07c2c8..6133bdbc1d6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # MultivariateUniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index 0932c015e84..f7ac71e1c92 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # MultivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 1626074359f..5f8b8875461 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # NormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index c16dd214eb2..2cae4333fac 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # UncertaintyModel - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Model @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index c1ac9100b11..de7467baae0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # UniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index ab17adfb748..cb750abe7cb 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # UnivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 8b3617dd0a8..5d6126aa9fe 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # UnivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index a9248fe6448..d9cb3d537b8 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # MultivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index fd8663cc6cc..b352bbe186e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # UncertaintyProblem - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Problem component. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 4125c130a9d..f543616d1b9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # UnivariatePiecewiseLinearObjective - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index 0bcb7444ed2..9fc1c64460a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # UnivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 5fe7e97318b..6b76c6fdef4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # VariationalForm - + Bases: `abc.ABC` Base class for VariationalForms. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -38,13 +38,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.mdx index 8b44044f882..65c3a716ced 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # OperatorBase - + Bases: `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -215,7 +215,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -239,7 +239,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 35ae8dafe00..354d867e3bd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.mdx index f520786ca64..7d23f01f9fe 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.mdx index ca51807c240..d1b1f422204 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 8053614e1e9..35e0d17232f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 49f46ff191f..3f2a214b837 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index 1984cf9a1ea..375e277a801 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index d55eabac99e..441d103b8d9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 544b5754497..a74eaa6117a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index ed1d68d349e..7096815aa6c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 70008eddffc..b414ebc507a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.mdx index 38629cb322d..3597748905c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # QDrift - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.mdx index 0d51887cb44..d9ecb3ad50e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # Suzuki - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.mdx index 93db0f61340..036e2f90c12 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # Trotter - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index 34ae6002646..52b858a4920 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 3aad16d1d37..3c630187687 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index da4e371d1f9..19c6c955784 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index bb8c3de0464..f673d4ebe67 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 1c3700e8777..cadd3c880da 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index 6795b9d8bbc..ef805ab5a47 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index f1e4176222c..2fe236a6f68 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.mdx index 3a6018906da..632fc594d4e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a7327e44e85..f048a7a8335 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 0bfdbf04e73..db85991aab9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.mdx index 6bd56bc19e6..35b5c9fdf05 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.mdx index fc18de875f7..e4c10595f35 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # Gradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.mdx index 009e7db36c6..e44c2be84fd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # GradientBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.mdx index 5752da18ad7..e63aad1202c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # Hessian - + Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.mdx index 00a946d2f99..56c66197221 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # HessianBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.mdx index f7ca7efcc59..850e9b1cd22 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.mdx index 1aad7ff4fad..c17ed5bbdf9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # QFI - + Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). @@ -70,7 +70,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.mdx index aa6f14122df..8e6619bc01c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # QFIBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index 7ae719f1b69..ad1c096634c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # LegacyBaseOperator - + Bases: `abc.ABC` Operators relevant for quantum applications. @@ -19,41 +19,41 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 7ac3f7afa7b..8de3f523e9e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # MatrixOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.mdx index 4d7d389194f..d43bc0ab342 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # PauliGraph - + Bases: `object` Pauli Graph. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index 424b0158386..8a450ff0dca 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # TPBGroupedWeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` TPB Grouped Weighted Pauli Operator @@ -246,7 +246,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -281,7 +281,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -427,7 +427,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -495,7 +495,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 9affe5f72cb..e12842aca91 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # WeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Weighted Pauli Operator @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index 5d900e25ac2..129cdcb1c31 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.mdx index ce01ab9dd91..67721bf3695 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.mdx index 45b52c955eb..cf42d2f9e48 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # ListOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.mdx index 341158f2a21..a27638803c1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # SummedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.mdx index 07abb514ca3..7d3ba79de8d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index fae608410e2..70667b867bd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index cc0f9e32acc..4e034c91803 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index 041a8c01567..d45a822f6bd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index dcba818f021..d2f8e6dde9c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index 61a7259a3b9..bb5714becf9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index e94241c69df..45248c10242 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.mdx index ad8040977a0..7feeca20e57 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 16fe296b89b..4a4e01fdfb3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.mdx index ed74b7583dc..5437497d9f6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # StateFn - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 30e10867f00..4c0c59406e8 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.mdx index d7f8dbdc4fa..ecc044c4948 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # CircuitFactory - + Bases: `abc.ABC` Base class for CircuitFactories @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.mdx index f1aa3759ed7..4abcc24e492 100644 --- a/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.mdx index 14b70f34e1b..0e69b3e1327 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # BosonicOperator - + Bases: `object` A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.mdx index 755645ff9e0..a2531481b19 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # FermionicOperator - + Bases: `object` A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.mdx index aaef115478c..7d69301eef0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # MP2Info - + Bases: `object` A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.mdx index 929578ad262..614e61aa471 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # QMolecule - + Bases: `object` Molecule data class containing driver result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.QMolecule ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ## Attributes diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.mdx index b71c74d9119..3152d6d8689 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.mdx index 76981917a3a..f7c6c8d4039 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # WatsonHamiltonian - + Bases: `object` Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.mdx index 7d59ab47203..d6254e5bfeb 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # AdaptVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.mdx index e2dbdd024c6..6bf04ba3ec8 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 7acf3e6d4e5..49fb5b86b42 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # EigensolverFactory - + Bases: `abc.ABC` A factory to construct a eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index a0662dd68b0..5054491f56f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # ExcitedStatesEigensolver - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 027fa1147f3..a8b9598a9d0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # ExcitedStatesSolver - + Bases: `abc.ABC` The excited states calculation interface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index b9b6ad6443d..4a910e2152d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # GroundStateEigensolver - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.mdx index 3267792eda6..b7ccf1d806a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # GroundStateSolver - + Bases: `abc.ABC` The ground state calculation interface @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index 8331af81f9e..8648cfeb832 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # MinimumEigensolverFactory - + Bases: `abc.ABC` A factory to construct a minimum eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index 8dc4c0de270..d13cc425e53 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # NumPyEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index e89fb1a8975..45e182fe353 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # NumPyMinimumEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index 0dc46d97840..9d0f0952027 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # OrbitalOptimizationVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.mdx index d92b8179a2c..03c18ce3b96 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # QEOM - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.mdx index 78a74d31efd..5aff9c4972b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # QEomEE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` QEomEE algorithm (classical) @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.mdx index 2eb99aada68..d5857a50e93 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # QEomVQE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` QEomVQE algorithm @@ -223,7 +223,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.mdx index 54dc2ad2973..74d85b7a88c 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # VQEAdapt - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 8fca437e6a9..d4a06ddeaa7 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # VQEUCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index a63b36a8272..2c6ed355267 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # VQEUVCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 0b390840a9c..bd5d4b229bf 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index a683fa04370..c0dc669f3c9 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # DifferentialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 27e410e16ff..b7275963137 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # EnergySurface1DSpline - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 25f70a61af8..3525e0c6eeb 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # EnergySurfaceBase - + Bases: `abc.ABC` Class to hold a potential energy surface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 8de6427da62..1de65277293 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # Extrapolator - + Bases: `abc.ABC` This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index a0206544ee6..25f9ed9bcff 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # HarmonicPotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Harmonic potential. @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 5015706a5f2..c902bd422a1 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # MorsePotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Morse potential. @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 615e12be689..ecf635421eb 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # PCAExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index a3a29eb223e..27a27dae52f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # PolynomialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 51dd046f4ec..c65d6156956 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # PotentialBase - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index aff661e9ed8..052e9f0b416 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # SieveExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index b815a63e469..d3370db7f4a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # VibronicStructureBase - + Bases: `abc.ABC` Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 171d29acd52..a7adb5d18a6 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # WindowExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index a2fda7467db..269402d4ade 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # MolecularGroundStateEnergy - + Bases: `object` Molecular ground state energy chemistry application @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 12b0e129750..b4cb06bf40d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # BosonicBasis - + Bases: `object` Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 21f29c60ca5..4d704c7766a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # HarmonicBasis - + Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0477a2e77de..2ca5a0596e4 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # HartreeFock - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.mdx index ad1d3a4b809..e1a82a2acca 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # VSCF - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.mdx index 0069a69dce6..e94b20d9231 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # CHC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is the Compact Heuristic for Chemistry. @@ -57,13 +57,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.mdx index d766d177baf..f55983c9e8f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # UCCSD - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -133,13 +133,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -242,7 +242,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.mdx index c562d5ba4f0..ced5cd3749b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # UVCC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. @@ -29,7 +29,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -92,13 +92,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.mdx index f3b5d34f829..26ce880b1b6 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # ChemistryOperator - + Bases: `abc.ABC` Base class for ChemistryOperator. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.mdx index c3d02503c31..8b77571600f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # Hamiltonian - + Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.mdx index de6c15fb604..2b7a47f7d00 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # MolecularChemistryResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Molecular chemistry Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 28e1b45db45..d19d2e6800b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # MolecularExcitedStatesResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Excited States Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.mdx index ed8e6534764..2d9ffbe9404 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # MolecularGroundStateResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Ground State Energy Result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.mdx index 666348dcaf4..78f73393146 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # QubitMappingType - + Bases: `enum.Enum` QubitMappingType enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.mdx index 9392f1f0b1f..5abc45e71b5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # TransformationType - + Bases: `enum.Enum` Transformation Type enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.mdx index 7c6c9ab9cfc..4747a964ac0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # BaseDriver - + Bases: `abc.ABC` Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.mdx index a7db32a28f3..073f583e8d1 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # BasisType - + Bases: `enum.Enum` Basis Type diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.mdx index aff1c967000..868bbee07c2 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # BosonicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry bosonic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 1216408cf01..599da6276eb 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # FCIDumpDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an FCIDump file. @@ -34,7 +34,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.mdx index e9f6b72ef12..2c42a3f2938 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # FermionicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry fermionic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.mdx index 5943db9b76d..0640d92fc2e 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # GaussianDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index 85a7aecafed..7c8678b3ba7 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # GaussianForcesDriver - + Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 4ad402137c9..b42232db85d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # GaussianLogDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.mdx index 08aa4bcfdff..9d9e7705241 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # GaussianLogResult - + Bases: `object` Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.mdx index b1bfd83ed76..2983f4b353e 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # HDF5Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.mdx index dc08dc847e3..162b3eb2516 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # HFMethodType - + Bases: `enum.Enum` HFMethodType Enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.mdx index 08a7733eeec..c9820ee0f8f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # InitialGuess - + Bases: `enum.Enum` Initial Guess Enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.mdx index a36d0286020..2acdd987aaa 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # Molecule - + Bases: `object` Driver-independent Molecule definition. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.mdx index 5c6813a19cb..aedb8e779b4 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # PSI4Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.mdx index 97894cf400b..926f0304864 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # PyQuanteDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.mdx index 362eeb690e9..a5ee29a3b09 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # PySCFDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.mdx index b66a5973b75..23b7a5bae69 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # UnitsType - + Bases: `enum.Enum` Units Type Enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.mdx index d5bff92b6b0..75f25624bb0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # BOPESSamplerResult - + Bases: `object` The BOPES Sampler result diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.mdx index 8d6bc9c45be..1524ed59c22 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # EigenstateResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` The eigenstate result interface. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.mdx index ce464992806..9ad2a642d9d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # ElectronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The electronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.mdx index 12a0c43f6e0..ead9f5c13f4 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # VibronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The vibronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 02f6d520c2b..4a289e1ef83 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # BosonicQubitMappingType - + Bases: `enum.Enum` BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.mdx index 080a2134680..44dd5f5c967 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # BosonicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.mdx index ab2a11023aa..12e20b37cf5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # BosonicTransformationType - + Bases: `enum.Enum` BosonicTransformationType enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index c6edc0b9f8e..ff4e023ff8b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # FermionicQubitMappingType - + Bases: `enum.Enum` FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.mdx index 9350be4572c..b14ecf68ea8 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # FermionicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.mdx index 6057596e1f1..32242e07ede 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # FermionicTransformationType - + Bases: `enum.Enum` Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.mdx index 111d61a35ad..e74bb582df2 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # Transformation - + Bases: `abc.ABC` Base class for transformation to qubit operators for chemistry problems @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.mdx index e60f961a777..e47582ab82b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.mdx index 9e027ef7a14..155d16095cc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.mdx index 2cd323170ec..ee67c6dbbb2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Clbit.mdx index 8742163072d..2408d0c4582 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.mdx index b3ca1f4682d..6be7c042a27 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Delay.mdx index e43ee362cb9..9256f3dcff1 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.mdx index 651d72bda11..816820911ab 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Gate.mdx index 77f20409a2f..e3bb4de81e8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Instruction.mdx index 623dffe5d2e..c10723365bc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.mdx index 1b7ccd3f0d3..cd4813aa260 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Measure.mdx index da8cad9d7a2..bafd07ccd01 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Parameter.mdx index d7e431a9f44..f9589202387 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.mdx index 651174034d8..47bbf312381 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.mdx index 841f8fa7ea9..09dc0d53847 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.mdx index cde9922fab9..b71f2457ddc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -340,13 +340,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -762,7 +762,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -780,7 +780,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.mdx index 7d2c607e976..d6bdc91fd07 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Qubit.mdx index 93f7ea5dc0f..cf400cfe296 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.31/qiskit.circuit.Reset.mdx index c685f9c77a8..fbf9b90ccd7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 8bcbf85ae5f..32565987ed0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 2f0d39e7816..5f28d3fd55b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index c5f63a79721..8746dfcea75 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 68e24fb0a52..1c216593b03 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.AND.mdx index aae6d1662da..08c3368aede 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.mdx index 5ec7657d560..10ed222937d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.mdx index 471b65e9eaa..e123f194577 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.mdx index 068492e37b1..666c938d95a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.mdx index ff67e0fb9cb..b1f9f816f80 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.mdx index 2a81088aa70..17cd9845d20 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index d120d3e0db9..c4f9d926524 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.mdx index 97b16435712..bf6c0da7a96 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.mdx index 6cebdde31dc..d52a658510c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.mdx index bd2447ddf5c..ab0bc1546df 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.mdx index 8b83153fa3d..a86a9329f07 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.mdx index 89064272392..f8f7814144a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.mdx index 00737bd9d36..082e5838b5f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.mdx index cd20a5736fa..211d99aa74d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.mdx index ae6885f5be0..40672693ada 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.mdx index e49b6e7c11f..16deee0f985 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.mdx index 612d0d89207..7459bb2291a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.mdx index 0f8eb3e9b60..7c63ea96316 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.mdx index 428538007fe..ae7f4cd903e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.mdx index ff804eedc5c..6a34cd3cfe2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.mdx index 733ae6e1174..6150234bdf4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.mdx index 1bad671175d..21888cd13e1 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.mdx index eb2b8f5ce77..92c71676148 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.mdx index 3e8e9d89928..4c6c5e3806d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.mdx index 81befc09631..035079ea0fe 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index e4cb2e7a4d9..408c134706d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.mdx index 528cb5941b4..61fc022081b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.mdx index 281d6a53ad3..031344a660d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.mdx index c9fb976b93e..721b89664e8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.mdx index 2aa3a21728f..9deb3192ef8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GR.mdx index 3d35154102c..71bc9a838e8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.mdx index be85fb70614..ce7ee8030a0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.mdx index 6a8539d7213..1e57f686328 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.mdx index 7b45706325f..f81a261f956 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.mdx index 9a0a8d4fa1b..eadfe9250cc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.mdx index e64f9455368..5334bb15cb7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.mdx index 4e7be8b3485..fc616994cee 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index c712a8b1ca2..cc6f25936bd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.mdx index d1fa5bc1a04..dc68b0ad37e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.mdx index bbe9cd36e7c..daecfc664c6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.mdx index 3894263553a..1d25f1817fd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.mdx index 4d4155bc246..eca93ad60f3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.mdx index 608168ff59c..7d602c274e5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.mdx index e3dd9e3f0d3..634d578d7a5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.mdx index 7a1eb0cdb05..59417e3e4bd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.mdx index 6ad70a48e7e..81592cfa921 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.mdx index 7209542a00f..1b1576d5e9d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.mdx index aae13bd190e..50662cbe4a3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.mdx index 10bd3fc657f..636244be9fc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.mdx index 8aee00f1a45..ef62d61bb74 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.mdx index 139c6d4cb8a..0aef8882f4e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.mdx index 83de799f5c7..0a25b85a0de 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.mdx index e236d61fcf0..8403196e4d8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.mdx index 1d5dc918cb9..6c46c743963 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.mdx index 5fc86d31022..dc2c6961452 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.mdx index 3f629df8ab9..20f6fefa821 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.mdx index 77bb89c4c35..ee329f61bb8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # NormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.OR.mdx index c6bebd0214b..5862a0b52ac 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.mdx index a3344152d4b..dab5273262b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.mdx index 41cc1f8a31c..6c26563d6c9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.mdx index c74fc599567..daac5d40a87 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.mdx index 5f20cd88125..6d3c84ededd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.mdx index 536082ceb6d..1b3a979a99b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.mdx index 1e1f5fe65aa..b6696b68f9e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.mdx index 4ce585eb7a2..ef39cdfd5d8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.mdx index 82d222a6f8b..59faa257ff3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 7869b940f22..7b195724d43 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 6b8ec05bb79..34e828e2f3f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.mdx index 8d2108ee68e..ae353d11676 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.mdx index 5001376e2b7..ac6b6ef75c7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.mdx index 7d172a9c0d5..79b9f3aa65c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.mdx index 10d6a1992ad..2516d78e22b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.mdx index ad5326bad9a..e3a82404f6b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.mdx index e765a279443..0db3a0f9e2b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.mdx index 1735b1b0e90..963ac994d72 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.mdx index 145e1a19d88..d28a5bc44fb 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.mdx index febbde25953..486941396dd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.mdx index 4e387b6353a..cf5f45608ef 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.mdx index f37a6592f72..de8afd18c2c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.mdx index a4ce87e1bc7..d0906b419f3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.mdx index 5fcfa9cd0ed..4c06fd205ac 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.mdx index a44258ef907..6e8e8d56282 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.mdx index 4fa70db923b..512e12e89a0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.mdx index af89584b29c..c1260d87b78 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.mdx index 7e51b7670c6..3a796a0a655 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.mdx index 704c0d7ba04..b03a3e1f4c2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.mdx index 3eef29d039d..7d80ece1a58 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.mdx index 63188080383..458f10b1f10 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.mdx index aab13bfa833..b4889a59440 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.mdx index df31e9a2384..14eb9de8c51 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.mdx index e3e0e5626c5..e10f453cba7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.mdx index a9011593cd3..9cab7c51fd8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.mdx index a1f033cc5aa..7eef8140bb3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.mdx index 5718062f000..90e6226eff3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.mdx index 8bfc12282f6..2f7a8e08058 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.mdx index 1ac3846ca02..3e67dfd31ac 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.mdx index 9b88878b07c..495b2e00c43 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.mdx index 4074cf925a3..95252b4175a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.mdx index ee8b10cc227..a2735f93635 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.mdx index 5335f5df3f2..f436b5c3122 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # UniformDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.mdx index a64b8bdb714..7c4d1d57d2d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.mdx index 0dcfe94e82d..36497bbe0e4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.mdx index 42b392fdb1d..460485d15ed 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.mdx index ac3957934e3..0e7ddc697b5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.mdx index fbbc51ee788..f7fad5ed841 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.mdx index bc889bd5caa..463fac676c1 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.mdx index 2f7edd290e0..4f0c40184c2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.mdx index 75aa982bf0f..705e7880612 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.mdx index ef7aa70fb20..455b12f2a95 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.mdx index 41c943cb863..bc021697fd1 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -257,7 +257,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.mdx index 74f1ba48a24..011f90528ed 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.mdx index 83e4ac1a1d4..f7d2cc4e0b8 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.mdx index 2cb2674edfd..60b0855825c 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.mdx index 838039d329f..61c5a3da024 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Object to represent the information at a node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.mdx index 3fb3afe478c..8bdaa059049 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.31/qiskit.extensions.Initialize.mdx index 2f3978fe2dd..8ad775b6a7b 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.31/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.mdx index f62fefcea9d..7c4483b3fa3 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.mdx index e8882b47179..86f03620389 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.mdx index 7bb360e35a2..36e35864bdf 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 9f1837295fc..2d456d2c7ac 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # EuropeanCallDelta - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Delta. diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index cfaab07cd5a..1f4c494db7d 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # EuropeanCallExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index fd50bef69be..6e98b4e9cca 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # FixedIncomeExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.mdx index 7ab21f7e4b2..e85a4d89430 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # BaseDataProvider - + Bases: `abc.ABC` The abstract base class for data\_provider modules within Qiskit’s finance module. @@ -121,7 +121,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.mdx index d9d6253096a..d8110b835e2 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # DataOnDemandProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.mdx index a4e6691270f..389c570e825 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # ExchangeDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Exchange data provider. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.mdx index fc5d311e67d..a1c4aca6fdd 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # RandomDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.mdx index dd09960bba9..824586df72d 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # StockMarket - + Bases: `enum.Enum` Stock Market enum diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 6ef858ed112..770eb99bcb0 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # WikipediaDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Wikipedia data provider. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.mdx index 9b794c8d7f8..b9ec38bc96e 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # YahooDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Yahoo data provider. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.mdx index cd05419fed3..05559c16c31 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.mdx index 35c8a1f8cda..cb92ec9c3b1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.mdx index e2a89865c05..e4c187fc67e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.mdx index 471990a07c3..7fc9bf54c70 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 2cb64c711ed..907ea65daa7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.mdx index 796c8ad4114..cba2388ba9a 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.mdx index d48de97f326..dbcf94e40b7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.mdx index d9f67871d54..7bd3b0e303b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.mdx index 78d0b83b466..d807ec2f107 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.mdx index 96080ca5386..5ef118f9af9 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.mdx index 9d2427a8ffe..0a72032970b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.mdx index 26dc2c9fa22..82c89cffd5d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.mdx index 37b8b831ae2..9bbcb2f8e2b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.mdx index c0fb4f02719..1d904cf6d1f 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.mdx index 4c32dcdd7ab..6ba1b091dbb 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.mdx index 4b68060ec45..6a25583bf86 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index a618b199d11..161b844ccc0 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 478ad70845e..5aeff445ff1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index ff2dbb2f975..6fdbc42bfa7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index eef37cc454a..c46b2f5c2fc 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 8048a03f161..41360446c85 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 047b5fb7e9b..dc5f46377c6 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 1d4689c9640..a88584c6401 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 378183cec6f..12fe0816a7d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.mdx index c87a2d0c724..40f693d31d1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index b10b5ddb96e..0f8fb908ad5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.mdx index 640f0f02bde..ce42be2f0c3 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 54a4c0a6834..69caa71c49e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.mdx index dd4034ae2ff..355df13ef86 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.mdx index 43306903dd2..96b8c74f4d2 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.mdx index 1472cd43dbd..94622b107aa 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.mdx index 41ef30dd784..20201b456b7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index c24f99de034..96eeb848007 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.mdx index b90f47dbf0c..1ce31cc35c4 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.mdx index af9c13ef001..f9cda6c23ee 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.mdx index 3d69f841152..fcb8721075c 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.mdx index 90f03443e78..6ffe80939ea 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.mdx index d3c3debf0cd..711f5553506 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.mdx index 2ae6db88219..2adfadd93f8 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.mdx index 7f291d2d3ab..e95ddfe13f2 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.mdx index a7f21ebbf32..d2548d72895 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.mdx index cfd9db2f212..c1640cd317e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.mdx index 8f3f0e35819..2025a3632d3 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.mdx index 222e4029b77..7698bd99556 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.mdx index d12b457298a..1ca359c07fa 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The raw feature vector circuit. @@ -128,7 +128,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -164,13 +164,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -586,7 +586,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -604,7 +604,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.mdx index 38d34b8c4df..149f4da528a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -207,7 +207,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -253,7 +253,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -271,7 +271,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.mdx index 69c8f8acafe..dd70307cb72 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.mdx index 06b358eb294..27943a01229 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.mdx index 09d211423d7..a14f211dacf 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.mdx index a1f404e66b6..d103f696cbd 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.mdx index 2febdbcdc38..abe43a3e1ab 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.mdx index 3e7b05568cf..89f3698a1b7 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.mdx index a2f9bc6ab12..1c6277cf6d9 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.mdx index 62e25e5412e..91bb9242c96 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.mdx index edb1f84d31d..4672e9e401e 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.mdx index 05af3b167a5..e6df4af3f09 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.mdx index 71d69092bd9..8b40ab664bb 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 6dac1bf3e20..0b8fe14fa33 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.mdx index 7ae4eed0cad..cd627826f11 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.mdx index 4bac8192c57..0d488be1b0c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.mdx index f19c6dedf5a..21699813034 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.mdx index d079c7dd33d..e314c4fc169 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.mdx index ce855140e8d..2601f58f901 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.mdx index 4aae59be22e..8e217c67c77 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.mdx index 6980e6d35d2..fc28ef6e490 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.mdx index 3bed350ae77..d75ae9f84f2 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.mdx index b0113af7825..341e9b4bdaa 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.mdx index 12acacdcaf7..ddad236dc9c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.mdx index e13e6fc2334..f8e0180659c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.mdx index 703b3aaeb23..4a8d87ccdf6 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.mdx index bd0311e7447..49a214c9a5b 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.mdx index 64aeb6d9cb8..5564b3d7f76 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.mdx index 0fc3150a6db..b3b61f5b5d1 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.mdx index a7e6e41a3b7..72a2c8000af 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.mdx index 4e19960c313..657d9e11304 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.mdx index 6ae5d1076cd..30e6dde2580 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.mdx index 79bceb8ff81..5deb277c4be 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.mdx index d4e81349854..78ab225933f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.mdx index 8223f03d774..9fc0b7412df 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.mdx index cb8494bf088..af8278bcf4d 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.mdx index b68bc55be03..5786e23fbd7 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.mdx index 503f03e3a0c..6be32eaa7c9 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.mdx index bf50c72e85f..06811dc1c54 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.mdx index e997228c2d8..d479c1d1de7 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.mdx index 394fccc90ab..e102b212a82 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.mdx index a266dfe0bbc..0a86648c03f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 53af0f3650c..e848d4068db 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backend by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index a3be025a6cd..e434d9ceb5f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 72b3f09afaa..ed3fa6516ee 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index da8ae03d781..1e18b9e151a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.mdx index ab08acd1f26..1eaf5b5fb9a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.mdx index 0bfffd6d323..b6b630d8622 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.mdx index bb30f9f1f3c..c0d39647960 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.mdx index b0a37588316..7edc0986e2a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index e0a6fd4b332..6b67ad6964f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.mdx index 5af81f4c8c6..75fc14d028c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.mdx index 3559ebab3ec..19969315164 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.mdx index 5a3c246fcfe..da2d10c2205 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.mdx index f91cf3e8057..37b7c663f62 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 51bef8ac0f3..dceed501e26 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # ADMMOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` ADMMOptimization Result. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 5208dfcc02f..79a48670ae4 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # ADMMOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.mdx index 77872f382be..692c38c30d5 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # ADMMParameters - + Bases: `object` Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.mdx index 40d6017d6fc..d6028e94257 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # ADMMState - + Bases: `object` Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.mdx index ea5943c1a0c..3430d5be0cb 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # CobylaOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.mdx index 227e3cca202..8bfe276e2d7 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # CplexOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -78,7 +78,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index d78d9e123c8..56ed0bd1297 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # GroverOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.mdx index c219cd129d1..70abc2b2200 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # GroverOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.mdx index 971f2fe4fc1..fcb45add97a 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # IntermediateResult - + Bases: `enum.Enum` Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 69b81353b66..329d902f358 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # MinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index c81a65e4e0d..26221a7b870 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # MinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 975756bf3a2..d7b755212ad 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # MultiStartOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` An abstract class that implements multi start optimization and should be sub-classed by other optimizers. @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index ba9d9e23142..4a55a766f83 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # OptimizationAlgorithm - + Bases: `abc.ABC` An abstract class for optimization algorithms in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.mdx index 0cddaaf87f0..2fd25e78252 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # OptimizationResult - + Bases: `object` A base class for optimization results. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index 69057e9376e..e74eb11bd7b 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # OptimizationResultStatus - + Bases: `enum.Enum` Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 616b8f64191..3dee30e4fa4 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # RecursiveMinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index 6333eedba90..d0252360631 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # RecursiveMinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index e18a64f6263..9aa5efdf8c9 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # SlsqpOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index b08d49889fe..a42fb7f32f0 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # SlsqpOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.mdx index a8f260f993a..3cb785a2b39 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # SolutionSample - + Bases: `object` A sample of an optimization solution diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.mdx index cf48c3a499a..03dded7cc15 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # InequalityToEquality - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.mdx index da4d1c5a0d3..db9b19e4920 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # IntegerToBinary - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index c68ef9a78fb..47597b8cc71 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # LinearEqualityToPenalty - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 4768a441cb3..4cfbd2cad5e 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # QuadraticProgramConverter - + Bases: `abc.ABC` An abstract class for converters of quadratic programs in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index 14232d52624..76c36b0b3b7 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # QuadraticProgramToQubo - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a given optimization problem to a new problem that is a QUBO. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.mdx index 62dc54b369c..9a07e8e12e5 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # Constraint - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Abstract Constraint Class. @@ -26,7 +26,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.mdx index 6ab377f4fd8..687e040c0cc 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # LinearConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a linear constraint. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.mdx index 25c1c8a747d..76733cff526 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # LinearExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.mdx index 047bb47877c..1a56fe27952 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # QuadraticConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.mdx index 82dc22dda07..e593560cdcb 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # QuadraticExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.mdx index 3e44d3e0e65..170ea1222c8 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # QuadraticObjective - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.mdx index c8ba5b87a39..c3a0e312d1c 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.mdx index 6541045e346..99f1d864f19 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # QuadraticProgramElement - + Bases: `object` Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.mdx index de3b48f2933..28ab69d31fd 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # Variable - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a variable. diff --git a/docs/api/qiskit/0.31/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.31/qiskit.providers.Backend.mdx index da3a7652b55..5e05195f14c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.mdx index f69330f7c6b..72a40076aab 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.31/qiskit.providers.BackendV1.mdx index bd36632dc3a..f8006dd85c3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.mdx index b16a7eb6418..b5cbfd97b58 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.BaseJob.mdx index c9c50736acb..d4d52ea1329 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.mdx index 82bcb368239..215c5de8291 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.Job.mdx b/docs/api/qiskit/0.31/qiskit.providers.Job.mdx index 54ecc0c89b3..6508be69518 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.31/qiskit.providers.JobError.mdx index e0b4465d8da..9288a244b73 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.31/qiskit.providers.JobStatus.mdx index 26d97f65d9f..21cece14df9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.mdx index 0662d1b43b0..3034325f70d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.31/qiskit.providers.JobV1.mdx index e696713dfec..19f7a2ac088 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.31/qiskit.providers.Options.mdx b/docs/api/qiskit/0.31/qiskit.providers.Options.mdx index 30143726dce..e2a64db46ab 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `types.SimpleNamespace` Base options object diff --git a/docs/api/qiskit/0.31/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.31/qiskit.providers.Provider.mdx index a1e4820a314..41a8286de36 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.mdx index ccd9e916034..9f6a4375441 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.mdx index c9eed91c692..c8399f862b8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.mdx index f5d45324e73..f86276b2b55 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.mdx index b0f97a7b4b5..9b6b15cd19d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.mdx index 1ac5ba580ec..36e5147d082 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -203,7 +203,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.mdx index 39b6b410f58..3bb0292b6c2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.mdx index 4c70ed73f8b..2ab073beb25 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.mdx index e1deda88448..d79a5cbc884 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.mdx index af36737f947..4de66c199e2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.mdx index 55f3fecd6ee..75c584658eb 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -92,7 +92,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 956dc81fa78..032ff2abb66 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index e6ba2e0b979..7b3b9bd0e30 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 45484f453a9..be630210442 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -90,7 +90,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 3fa086b7f9f..f5ed53ce05c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 035119c2653..c0493cab342 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.mdx index e8d0f031bd3..447011556f7 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.mdx index 0b968f7c1d0..35fface0455 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.mdx index 4b3c327f2b5..13c5db051f2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 85eadc1d527..fbceab7db97 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 687c86423d2..b5cd3012899 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.mdx index d8e93822c50..cf0e9be7f3d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index bf8b482a55a..c731e70a1ae 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.mdx index 0d3d5fb38e0..d75cf11c4a5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.mdx index c5fbc3073b7..da2d0dd18f2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index e9910051e9f..0bc92eb7fad 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.mdx index 9919d798541..fb243b689e1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.mdx index ca0424db96c..d6ac2638997 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.mdx index 2c09133118d..3728e10f193 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 625d7138068..54df40d0906 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.mdx index 4e282a0fdac..7d24905be18 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.mdx index f8a9573ca3f..fa3adb49c42 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.mdx index 66727e2448a..a3524b1ea67 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.mdx index 2f707161b99..96b835afea5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.mdx index d3182a6f85f..2aac219d97f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.mdx index 36f8e6b3971..10a18500db1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.mdx index 0e98c4261df..40566ada3d1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.mdx index ca5dd902eab..52045e58a17 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.mdx index f42e7bf27b0..dac95973dcd 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.mdx index a5c7ee1c806..a0219f8d41b 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `object` Quantum error class for Qiskit Aer noise model @@ -180,13 +180,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.mdx index d8f483dbd02..6ab625de8c6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -153,13 +153,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 5d1fec56e1e..b6ec7e26958 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.mdx index 077844871bd..7fcfa708655 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.mdx index bd5d2c2b441..1d4d1312c2e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.mdx index a2c3bb842db..34e53bdba4e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.mdx index de74083a1a2..b37d065031f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9314006cf7d..78f741cd891 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 43cd26238a7..f6e9ed4ae0a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index e1c871e48d8..e7433a01f51 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.mdx index c0d26e61dd5..ac822fa2513 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.mdx index 7a01d244093..7a70fe5b837 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index dd535557f8c..3783dcb7163 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 6c52a5d092d..912c2bab248 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 3e2e589529a..ca1edc89be0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index b2caa026471..80ed9370af3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.mdx index 617d6028885..5dcd9098338 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index ccd8d2cab44..126496798c5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.mdx index da3562dbf79..06ef481490c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.mdx index d7291832296..9e4100d83c5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index ee643275344..88d1817608d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.mdx index a1aaf7928d0..fc6bce5a056 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.mdx index 176cdd8d135..8c622d2e7ed 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 11e65e373d8..1c534b7d20e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.mdx index dbf03d1cfd6..5ba47a01fb1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.mdx index bc8af58a15f..485fe1eeeca 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.mdx index 7f89e0e47da..b866bcb2d43 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.mdx index 654f2c6470a..c6eeb5b9257 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.mdx index e220efcffb9..db18cdafc3d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 1e0695dc0f4..a7ef7fc19e9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 34151cdbec8..bf26582b996 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 3d9f8f15659..4ede5da85c3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index b370236d3c8..b85ee871194 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index f2a3e3917f6..e4122236b73 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index c0f1e523dfa..95ba342fcef 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index e1c0a7d4aa1..70d06004486 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index c1c7fede275..599642148c7 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.mdx index eedcb167a9c..6fc00224b28 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.mdx index 722827983c2..f2147d0d66d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 082fcd1cb29..6463e85af9d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.mdx index 82d757480b1..ebb567d17a8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index e07480dc303..76de547e541 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index aa4625e7075..52d97cd1dcd 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index d8e6dbb9421..c1164bd26b1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.mdx index d9b84c04262..72a537e0a35 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 2b89e85a11d..6b8ff11cf25 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 0f7707709b6..d6b8e0830d1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 86d06affc67..9469e25591f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 305e6f7925f..36c5327d896 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 1f17f10afd9..148f97dc586 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 70a2181a076..a6da131228a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 86294f3637e..c38813bdf8e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.mdx index a390075c1c4..37f37af7598 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index c7311adee86..199e10de048 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.mdx index 23c45a51735..669b7281ab0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.mdx index 93a974e9af7..3b0cfb1efc5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index db4d04a634f..968a70f099d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.mdx index 996ae69b00f..58a8caf4ab0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 7a878a723b5..285d05c9c65 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index d5846d4b7e8..08276544e2c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index ffcbb1a120d..73b1cba3682 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index c32de010184..e487f33882a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index 77ec959b919..cff767e1eb9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 670ccc48fe6..dafd08d3a4b 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index d352a95a0c8..925fa7a1d44 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index ba8595a30ec..7b0fbe2495f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 787bbac0c5a..1c1d93a7090 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.mdx index df3eec4af33..e918da4236c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.mdx index 77d1fdc8179..1c4bde79839 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.mdx index 21e87bf2375..721c21747af 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.Command.mdx index 16a2ea5505e..50cd1f6bf55 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.mdx index 13586a9d476..de60478e5a6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.mdx index cb44704c9f2..47616218175 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.mdx index 237830bbcb9..7e6ba952bd2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.mdx index f94da9524c7..ec2aa302e11 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.mdx index af5fb36db89..9c26f781764 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.mdx index 007d38dcc2a..6c09d232fda 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Acquire.mdx index c46affcf243..eaeab81591a 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.mdx index 3b4390572c3..c5d06bd8ed0 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # AcquireChannel - + Bases: `qiskit.pulse.channels.Channel` Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Call.mdx index f151ba8efd1..47fb7c293de 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Constant.mdx index 03b3cf4f08c..0f0be66e7b3 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.mdx index d3d4550a91a..03b83c73efa 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Delay.mdx index 6274766068b..72ede7938b6 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Drag.mdx index d641be206ca..69cfb7778df 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.mdx index b0c081287e1..6342fe06263 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.mdx index 7239447283c..e3140a854d3 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.mdx index b7627fb089a..edf5e9e1848 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Instruction.mdx index 12dcbd180c2..7887bd36a08 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.mdx index 34ab0f5aba0..97d2b9a6ae5 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.mdx index 2406d6ddad0..5ffae39cddf 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.mdx index ed27d7e5171..a1667df5ff0 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.Channel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Play.mdx index e1d51dadbcc..72d5412bab9 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.31/qiskit.pulse.PulseError.mdx index ca8a63aae19..6c4a5209ca4 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.mdx index 8b413549bda..22d9d2534cf 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.Channel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Schedule.mdx index 140ab9fc9f2..1c77775f356 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -296,7 +296,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.mdx index 8b97bfbb906..88da85b43ff 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -295,7 +295,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.mdx index 8fb5f108629..c3335f82fa3 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.mdx index 3e5d6200fde..de3cdce12bb 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.mdx index 93e46a07f22..9c9c766c12f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.mdx index fb79ac431eb..75edfdeaf40 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.mdx index 90858c62fda..5db8a3ef85f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.31/qiskit.pulse.Waveform.mdx index 780d837b6f8..9af0eb34e13 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.mdx index 0abccea3dab..501f81b2380 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.mdx index d639c707f65..8cb6fc9b292 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.mdx index ea1dc87c499..ccbd34db68f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.mdx index b593356bf32..dd7c65e99d7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.mdx index 0034967f27b..8b8ea86fed1 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.mdx index 984cfc81cd8..7cec9fadecc 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.mdx index b8f649e8eb0..9edbe40b8b4 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.mdx index 1b16be0b1a9..c2d69b0cb36 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.mdx index 50892b62692..a6831d826d5 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.mdx index 6c3dd77ea24..c350a17086a 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.mdx index 4184f268ebc..52e3da88aad 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.mdx index 80b66d60df7..bf98cdf5146 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.mdx index 2c61e27b4f6..f8b4d22ee56 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.mdx index 7182421becf..1b342d82041 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.mdx index fcd2b6c9539..da3b290edef 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.mdx index ff87cec855a..6aa25cb8683 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.31/qiskit.qasm.Qasm.mdx index dfe2bc265a3..ee416b485d7 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.31/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.31/qiskit.qasm.QasmError.mdx index 1fee3b72dd5..d644aafdce6 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.mdx index 3175a24235e..8a75e46f579 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.mdx index 07db1b7f478..94b7bc6e13b 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.mdx index 787f8e54b05..8ba473f21c7 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.mdx index b0dcded88f7..961f5fbc5eb 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.mdx index 6b0bc938ddf..1de601a7622 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.mdx index d615fb5e98b..7b584800b3c 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.mdx index 7f014f78fc6..0d2e71ac736 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.mdx index ed924abb218..aef0f5c9e38 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.mdx index 0938a0f479e..7eff2daa6b1 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.mdx index 6ab7b245f1a..760936cb3be 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.mdx index 492c4cb275d..ff4d9d86086 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.mdx index 5266d26b602..d6375345104 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.mdx index 5aa7935b61b..3a9b20709a6 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.mdx index 376ce1979d4..69f33477d2f 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.mdx index 645337a5946..4670a95d788 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.31/qiskit.qobj.Qobj.mdx index d3b93718154..304342d2ccc 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.mdx index 3a4e3bb91e3..61c2b439545 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.mdx index ae6aca77470..3b48e646c30 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.mdx index f7a32cf39ac..dcf3049a9ae 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.mdx index 23558fb64bd..f1eee674849 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.mdx index 63f21af5c05..3defd7bf44e 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.mdx index 79e5803cb2a..7ab00722f55 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.mdx index 76eb29b3662..d111340e1c3 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.mdx index c8ff5f7a644..c7794c4a04b 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.mdx index f0ab29c1830..2cf7a5617cb 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index cbcc74d4a49..e5814f3fd96 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.mdx index 3aa2cc46607..f6427a78321 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.mdx index f04a63d5a70..39e99d5a841 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.mdx index e9c62f99e8d..947d1c69b25 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -335,7 +335,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -455,7 +455,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -497,7 +497,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -542,7 +542,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -556,7 +556,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.mdx index 997f13019fa..7bd11db55aa 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -363,7 +363,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.mdx index 99c74b22e98..814d3c1981b 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.mdx index 93182821c26..890fd2e73d7 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.mdx index 268a8a27469..987aa2217b8 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.mdx index 97088458d15..c7f0fe360f5 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -121,13 +121,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.mdx index 2b24f2e06f9..e017c9a2518 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.mdx index 4439e69dd7e..4d81e048209 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.mdx index e3f122155ac..9e9ec1833cb 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -178,7 +178,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -202,7 +202,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -228,7 +228,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.mdx index e6bae9cd6ea..0b106b77207 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.mdx index 435e5f7f66f..4a3d460e981 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 364a3315218..2306ef07ff4 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.31/qiskit.result.Counts.mdx b/docs/api/qiskit/0.31/qiskit.result.Counts.mdx index 158a1a4df8e..9b1b034e6d7 100644 --- a/docs/api/qiskit/0.31/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.31/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.mdx index 72cdecfa8a4..f6b6bfcbe5b 100644 --- a/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.mdx index 5244c68e1a8..64583f12b9d 100644 --- a/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.31/qiskit.result.Result.mdx b/docs/api/qiskit/0.31/qiskit.result.Result.mdx index 4501570076e..ef166e7a2db 100644 --- a/docs/api/qiskit/0.31/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.31/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.31/qiskit.result.ResultError.mdx index e80c051198f..9a2fb418993 100644 --- a/docs/api/qiskit/0.31/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.31/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.mdx index bceabdb134a..e8dfa7d43f6 100644 --- a/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.mdx index 0103bc72544..ba5f7702eb5 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.mdx index 665aa86e542..a685ebc5325 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -89,25 +89,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.mdx index 2dfb47712ab..552fc450f13 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.mdx index bf8cd388da6..bf46d7cb7bb 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.mdx index f3487c8d57f..afbf44b10fd 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.mdx index 4531ba5634b..d1c89542d6c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.Layout.mdx index 66dfdf1dce5..8e3a6f04683 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.mdx index dc44aadcefa..7d3750743a1 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.mdx index 0fdb65ac9b5..373ccf1770b 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.mdx index 1424acdfdf1..b78cd0675ff 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.mdx index 7454bf8f37b..83a209c7b15 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.mdx index 32abb7d32c7..f5e7ba9af8c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.mdx index 39abe7bc7fb..9eb783e480a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.mdx index 38295935694..d125742b206 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ALAP Scheduling. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.mdx index 51ceb2dfae9..3d6ff6d7001 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ASAP Scheduling. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.mdx index e293cbf19db..b54daca5578 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.mdx index 6897f1689f8..34c0da5a1e2 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.mdx index 78dad80e642..3c33be38436 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index d1fa3c2c55a..4600bbcdae9 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.mdx index 530cfa152a5..655038ed913 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.mdx index f688563cdda..83bba6c76db 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.mdx index 54cf75273fa..2ad60c74a37 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.mdx index a18492dcbfd..99943f34bbd 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.mdx index 3d66a5832ab..a54d042e870 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.mdx index 1db8bb2062d..6d4ed01da2c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.mdx index 2cb436c3808..aaa868860b1 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.mdx index bfbc0df66ea..f211a83dc2e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.mdx index fba6454cd0a..b77ba82085e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.mdx index a9b9525387c..ff1007a7e23 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.mdx index 5e26bc707ec..736f9f68af4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 2d6dd13bc91..1e3834dc7cc 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.mdx index e5fd169cc9f..df56f82a5a4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 147283b7486..735092c4c2e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 71908291200..77d3f828d3a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.mdx index 80f41d00250..77f9737e21c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.mdx index 616bc9db666..ffdbefa4bfe 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.mdx index 801dda46e8e..2148594fe22 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.mdx index 21b01bea5de..67f62e2503b 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.mdx index 51b17f3e8b1..8587a9fba15 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.mdx index a25c89c57e0..4e8915bb4ea 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 909b96f0577..9930da83fe2 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.mdx index 3b5f740f6e8..137acd1f151 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 509f1962490..d63279ef495 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.mdx index a6011195098..d69ea681de9 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.mdx index 7d156d59295..c41c95d13d1 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.mdx index 00eed73c469..2a69348ebf7 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 6afee12337a..3c21d1749b7 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 99ceb9d7892..1aeaf747b3a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.mdx index 598751f3e13..111e4e445a1 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.mdx index 464a43468d3..1e39bc9f9c4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 37570f0c4aa..24d9a6ab333 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 561f6872895..b42550a839d 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 30991351e79..f74732a93b6 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.mdx index 0b87683ad62..6080ea54ee3 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 1f34ed4cbd9..f180dc84fee 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 84cf5091c36..d074850769c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index a58a5f616e6..9a9854be12a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.mdx index 64cce077218..0bdd1e1f7e5 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.mdx index 304378dbd1e..68e0ee75ccb 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.mdx index 3c313b4afb5..4e5ef4b3199 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.mdx index f2944f69e21..8952d6b77a8 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.mdx index dffc58a8e88..412919a680d 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.mdx index 3424dba5bce..8681fba39b0 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.mdx index b9bb9d5aa99..fdf23171eaf 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.mdx index 55ae91c577b..95c98a4fed9 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.mdx index c647c006fef..d8de9ab7ab8 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f21a57c9603..509e4c7a572 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 228d354d16d..b249d1645c6 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.mdx index 84a0c29e7b7..49f13d101cf 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.mdx index 31bb14e608a..159c8b45b11 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.mdx index 41a31e8b8fe..ad3d7baa0da 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.mdx index 52ba4d23cf8..8e24ef8fd5f 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.mdx index c37360eb77c..ee9faa63b85 100644 --- a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.mdx index 78e42abd197..0190b8691f5 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.mdx index be478fc23ef..0fa502a9d79 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.mdx index 2d1e4fca4fc..a0f25da183f 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.mdx index 090758ed8db..39ada062624 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.mdx index ccfbaad8d57..44af67d38c5 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.32/logging.mdx b/docs/api/qiskit/0.32/logging.mdx index cc977ff0d50..1dd614028bb 100644 --- a/docs/api/qiskit/0.32/logging.mdx +++ b/docs/api/qiskit/0.32/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.mdx index 27bbb468033..868c57f157a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.mdx index ce3b0f96ba6..e20a18111bd 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.mdx index c541e58a1df..b717e80e269 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.mdx index 17eb1853697..5c71dedbbb1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.mdx index 00fe5f33265..7b60153afc2 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `object` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 70509ef002c..13f297c80c3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.mdx index 70ad6b4aac9..46c071c2558 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.mdx index 87f8f9daedf..3b83d666e6a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.mdx index b3a77b6b9db..60697f8df81 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.mdx index d3c13046118..926c14a5a2c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 71aa0b7e804..da6299681f6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.mdx index 8a54d0aabeb..94ce6937615 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -126,7 +126,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.mdx index fa839512092..db3d7fda816 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.mdx index a4e9de7af3d..90d217a6b9b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e6952740e95..82e9e4b2275 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 726bc19ddb6..2a6c97c6a47 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index bb5e2210467..9d0ec6dcaa6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 48dbc87a0b1..f05969ede56 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.mdx index a9ebb7bb044..1cae4e83965 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.mdx index dcc0a8e1f50..e063b75d0c5 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.mdx index 4498e3ed742..68f299d8a59 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c60203087a5..b18d8cd3cd5 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 4d84642032b..10517e02a48 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.mdx index 756ebc0587b..1e7f05b57a2 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.mdx index 4099331d509..54cb3ed1107 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.mdx index a38ebecbb7a..b608d75dd2f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.mdx index e1ffbabdca0..9debe18386d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ebcb21aa0d8..df1cc669880 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.mdx index a88f52356f2..532d2e5c729 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.mdx index 41de4387e57..e3262c9bf92 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.mdx index 258ebaef686..2471882a19a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.mdx index ff950a6c2a1..ca740d09700 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -215,7 +215,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.mdx index a17bd5abdd8..9d78a9a43bd 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.mdx index c3e1f75812b..ba9ef7320b6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.mdx index b220e0296b5..db3837890d0 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.mdx index b96c232ce64..9f31ba86c13 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -178,7 +178,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.mdx index 9e2d1ea1b3d..090c58abf17 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.mdx index 7467bec47a8..af8f6e6a358 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.mdx index 11c359e84ec..4eb9d57eb3e 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.mdx index 1c93a34eefd..7de0ef061a3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.mdx index b9d9301afe8..b7271ebabba 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.mdx index 655a14df4e8..b3e3ed94133 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 354e31bc7c8..416e5ce797f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.mdx index 9ddc42b2760..4da5c79bb4e 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.mdx index 3c0f22fb9ae..c0a001cbbb7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.mdx index 530732ff721..7e184732561 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -117,7 +117,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.mdx index 7e8c93af72b..4910f58e8ed 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.mdx index a93bb96b039..2cd15aa6907 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 61ddde0accc..c86aeef4204 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 432677ac538..1e28de32423 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx index 8fecaa95805..0d16ef55736 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.mdx index 5a0853a72b3..63ff55ed780 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 95cfd0c9224..64e5b9caea7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.mdx index 6b0d9afe1fd..66318cfcdf3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.mdx index 919c08c8b01..fcac617b5cf 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.mdx index b68593c056f..6ccd956db86 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -104,7 +104,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -114,7 +114,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -148,7 +148,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -217,7 +217,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.mdx index 8c871303961..fa7cee21549 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -109,7 +109,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.mdx index a49784b3a49..325141ee691 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.mdx index 7d1895a56c3..56d78602473 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -96,7 +96,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -129,7 +129,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index fefb1663818..8c9a91d5ac6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.mdx index fcb3446be45..868194f1061 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.mdx b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.mdx index 1f61f9c108e..fdb9020ae4b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.AquaError # qiskit.aqua.AquaError - + Base class for errors raised by Aqua. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.mdx b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.mdx index 7f2568205fe..f5c6442b543 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError # qiskit.aqua.MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.mdx index e7cd4f84cc3..8ca862417e3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.mdx index ae18bbc59fe..bcbbb435929 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx index 0daca935eeb..06e5cfab49c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult # AmplitudeEstimationAlgorithmResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` AmplitudeEstimationAlgorithm Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx index 8e042284a76..16ee4734a6e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` AmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.mdx index d158e777dbf..1623ad79433 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani # BernsteinVazirani - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx index bafd330cb94..211a42e58d2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm # ClassicalAlgorithm - + Bases: `abc.ABC` Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.mdx index 7ea1864f8cf..4ee685156f7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX # ClassicalCPLEX - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.mdx index bc52ede6d91..f1e863e00d0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa # DeutschJozsa - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.mdx index cf4fb86247b..a8bd3cf01e9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EOH # EOH - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.mdx index 0bd258c29e4..b1bf5d10f37 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.mdx index 6ba69c1b56a..771cae801aa 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.mdx index b691284ec7a..20c5c47ecd2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Grover # Grover - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Grover’s Search algorithm. @@ -132,7 +132,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.mdx index 34ff167c211..22754f143d1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult # GroverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Grover Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.mdx index 91b20ef5214..44a9e97400e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHL # HHL - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The HHL algorithm. @@ -74,7 +74,7 @@ $$ ### expand\_to\_hermitian - + Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. **Parameters** @@ -93,7 +93,7 @@ $$ ### expand\_to\_powerdim - + Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. **Parameters** @@ -112,7 +112,7 @@ $$ ### matrix\_resize - + Resizes matrix if necessary **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.mdx index 052864ee11a..2bd1c4108e8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult # HHLResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` HHL Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.mdx index 794aaa3e056..f1b8f6bc2cb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE # IQPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Iterative Quantum Phase Estimation algorithm. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx index acfc3344319..2c5cc177bbf 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx index b4d4cc41f12..043cc9ca927 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` IterativeAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.mdx index d884d0798d3..cc31377928b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult # LinearsolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Linear solver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 29abec34ad9..84dda7a68c6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index bf23c4e2c5a..21630a4c8c9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` MaximumLikelihoodAmplitudeEstimation Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.mdx index 595f945114a..b5a49f30e72 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx index b34c0a78193..d7c48d458c7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.mdx index 66d526f91a9..97fabc6ac2d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -63,7 +63,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.mdx index 8f849c80ed2..a040186dd97 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver # NumPyLSsolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx index 894372c48f6..13b32c25fb6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult # NumPyLSsolverResult - + Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` Numpy LinearSystem Result. @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### from\_dict - + create new object from a dictionary **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx index 7430c317278..69df9a4b40b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.mdx index a476d05a605..e80e2f5cf31 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA # QAOA - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.mdx index 89844fbf513..0247d398c98 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN # QGAN - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.mdx index 00ec2a39fda..2bb59eda2e7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QPE # QPE - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Quantum Phase Estimation algorithm. @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.mdx index b834ebe046a..46f191cc1c5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM # QSVM - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Quantum SVM algorithm. @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### get\_kernel\_matrix - + Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. **Notes** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.mdx index 0ba85ad92cd..f55e9a33a2a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm # QuantumAlgorithm - + Bases: `abc.ABC` Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.mdx index 5e41c8e070b..2c0b77a00da 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Shor # Shor - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` Shor’s factoring algorithm. @@ -57,7 +57,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.mdx index a0e34d193c5..f57574cfaa1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.Simon # Simon - + Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` The Simon algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.mdx index c6048af9e22..4fc369c2dc0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM # SklearnSVM - + Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.mdx index d4fb976a730..9d3e50a3404 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQC # VQC - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.mdx b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.mdx index a2c65fb86af..fd46719101a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.algorithms.VQE # VQE - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -223,7 +223,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.mdx index 5bf84eaa937..cbe5430c32c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.CNF # CNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.mdx index a8a1baf02af..4ceb6aea257 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.DNF # DNF - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.mdx index 3c79c6e8093..ee982de53b9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.ESOP # ESOP - + Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx index abd32e1cdc0..5e74db7bb5d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit # PhaseEstimationCircuit - + Bases: `object` Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.mdx index aae1333c99d..667eff19e84 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit # StateVectorCircuit - + Bases: `object` Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.mdx index d5d517e89c9..ce90c018fd2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator # WeightedSumOperator - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Adds q^T \* w to separate register for non-negative integer weights w. @@ -119,7 +119,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator ### get\_required\_sum\_qubits - + get required sum qubits diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.mdx index 675c831dc5a..83aadbb5491 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues # Eigenvalues - + Bases: `abc.ABC` Base class for eigenvalue estimation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### construct\_circuit - + Construct the eigenvalue estimation quantum circuit. **Parameters** @@ -68,13 +68,13 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues ### get\_register\_sizes - + get register sizes ### get\_scaling - + get scaling diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.mdx index f8ee08c4353..867e7349794 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE # EigsQPE - + Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.mdx index c3ee92ba022..abe7deed93e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap # FeatureMap - + Bases: `abc.ABC` Base class for FeatureMap. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx index 27b7f557148..7c89e12dabc 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` Raw Feature Vector feature map. @@ -48,13 +48,13 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector ### get\_entangler\_map - + get entangle map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.mdx index 6447c481b53..d1e18855453 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom # Custom - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The custom initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.mdx index a6f130beaed..0375875d925 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState # InitialState - + Bases: `abc.ABC` Base class for InitialState. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState ### construct\_circuit - + Construct the statevector of desired initial state. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.mdx index ef0e560fb3d..895fa842fd9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased # VarFormBased - + Bases: `object` The variational form based initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.mdx index 4a900516297..58397e57632 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero # Zero - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx index 77097eaa48f..2fb87e48c22 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs # AllPairs - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx index 2b86bad395f..5c9987ed5da 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod # ErrorCorrectingCode - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx index 8781ea7ca25..cbd49a120ba 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio # MulticlassExtension - + Bases: `abc.ABC` Base class for multiclass extension. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### predict - + Applying multiple estimators for prediction. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### test - + Testing multiple estimators each for distinguishing a pair of classes. **Parameters** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio ### train - + Training multiple estimators each for distinguishing a pair of classes. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx index d23ad79895b..38481ba0356 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest # OneAgainstRest - + Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx index ab65b051646..f6d227cfd49 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork # DiscriminativeNetwork - + Bases: `abc.ABC` Base class for discriminative Quantum or Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### get\_label - + Apply quantum/classical neural network to the given input sample and compute the respective data label **Parameters** @@ -33,7 +33,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### loss - + Loss function used for optimization **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### save\_model - + Save discriminator model **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork ### train - + Perform one training step w\.r.t to the discriminator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx index 2d499b7cae3..cac1ab34f29 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork # GenerativeNetwork - + Bases: `abc.ABC` Base class for generative Quantum and Classical Neural Networks. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### get\_output - + Apply quantum/classical neural network to given input and get the respective output **Parameters** @@ -39,13 +39,13 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### loss - + Loss function used for optimization ### set\_discriminator - + Set discriminator network. **Parameters** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### set\_seed - + Set seed. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork ### train - + Perform one training step w\.r.t to the generator’s parameters **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx index 3fc887bc77b..49ab5bce4f3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator # NumPyDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on NumPy diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx index 6bf01bb0067..05eebaff1e2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator # PyTorchDiscriminator - + Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx index 87237b296d8..adcd045b540 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator # QuantumGenerator - + Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` Quantum Generator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.mdx index 38f6182d7ec..49b16fa83c0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM # ADAM - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -174,7 +174,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.mdx index e4a9969bf4d..a363ba2b977 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD # AQGD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.mdx index 7946e658e48..8ce7b43d6a0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.mdx index 6ad5978091c..61747582c08 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG # CG - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Conjugate Gradient optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.mdx index 24695fa91a2..a39df858920 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA # COBYLA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Constrained Optimization By Linear Approximation optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.mdx index c80d56326d4..28421a7117a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS # CRS - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.mdx index 8fe0fbb9941..1f9667b6351 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx index 12e9e03ca89..ec2a74e5812 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.mdx index 5fefe583b59..9e156b22bbf 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH # ESCH - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.mdx index b7b984313da..5f22a8130a1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS # GSLS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -71,7 +71,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.mdx index 49fa6c8cab6..fc70bfd3b7b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL # IMFIL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -86,7 +86,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.mdx index 95a45c07256..125ba03e926 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES # ISRES - + Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -114,7 +114,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.mdx index 21af907f212..0479473c1d1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Limited-memory BFGS Bound optimizer. @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx index b363ba9e541..a2e75f2f8da 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nelder-Mead optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx index e8f4594a56d..e2fef891fa7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT # NFT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Nakanishi-Fujii-Todo algorithm. @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.mdx index 2fa3469e9e7..cfd9af18e80 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### optimize - + Perform optimization. **Parameters** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx index 89a9711d203..f07f7589643 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.mdx index 4168ebac7c4..9b8a190e473 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL # POWELL - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Powell optimizer. @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.mdx index 35656a9b66a..7a177a4aa99 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Parallelized Limited-memory BFGS optimizer. @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.mdx index 06cc2c7f4d6..2079f7a18bc 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP # SLSQP - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Sequential Least SQuares Programming optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.mdx index d1d18448d60..42cc5441e89 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.mdx index f46d3ceed8c..82ec517b53a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA # SPSA - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -52,7 +52,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.mdx index b01ec640cb7..62c13f35160 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC # TNC - + Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` Truncated Newton (TNC) optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx index 51c2f5e1f8b..4c68259fe2c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle # CustomCircuitOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx index 80ee7dcc639..9ddc9616bdd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle # LogicalExpressionOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.mdx index 39f5057a134..62e7faa0e5b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle # Oracle - + Bases: `abc.ABC` Base class for oracles. @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### construct\_circuit - + Construct the oracle circuit. **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.mdx index b5dc61c3e15..86be4315904 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle # TruthTableOracle - + Bases: `qiskit.aqua.components.oracles.oracle.Oracle` The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.mdx index cce4819e748..90d09ff3d93 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision # LongDivision - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.mdx index f3de6ac158c..511babc009f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation # LookupRotation - + Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.mdx index 876f8f0291f..fcfe3006f18 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal # Reciprocal - + Bases: `abc.ABC` Base class for reciprocal calculation. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### construct\_circuit - + Construct the initial state circuit. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal ### sv\_to\_resvec - + Convert statevector to result vector. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx index e768edb2794..62b51684d0e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution # BernoulliDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Bernoulli Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx index 258208b5e7d..534f31cdd8e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn # GaussianConditionalIndependenceModel - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Gaussian Conditional Independence Model for Credit Risk. @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx index 432cd96cf0c..57cdba473a6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Log-Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx index 8edeb4ad3be..33c01da171f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut # MultivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -104,7 +104,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx index 6f560d7308d..43b9eb602a5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal # MultivariateLogNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Log-Normal Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx index 44d51bf056d..f1e6753aa4d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis # MultivariateNormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx index 1608f07c2c8..6133bdbc1d6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi # MultivariateUniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx index 0932c015e84..f7ac71e1c92 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation # MultivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` The Multivariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation ### pdf\_to\_probabilities - + pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx index 1626074359f..5f8b8875461 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution # NormalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Normal Distribution. @@ -107,7 +107,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx index c16dd214eb2..2cae4333fac 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel # UncertaintyModel - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Model @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx index c1ac9100b11..de7467baae0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution # UniformDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Uniform Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx index ab17adfb748..cb750abe7cb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio # UnivariateDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx index 8b3617dd0a8..5d6126aa9fe 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational # UnivariateVariationalDistribution - + Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` The Univariate Variational Distribution. @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational ### pdf\_to\_probabilities - + Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx index a9248fe6448..d9cb3d537b8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem # MultivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx index fd8663cc6cc..b352bbe186e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem # UncertaintyProblem - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` The abstract Uncertainty Problem component. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx index 4125c130a9d..f543616d1b9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise # UnivariatePiecewiseLinearObjective - + Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx index 0bcb7444ed2..9fc1c64460a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem # UnivariateProblem - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.mdx index 5fe7e97318b..6b76c6fdef4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm # VariationalForm - + Bases: `abc.ABC` Base class for VariationalForms. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### construct\_circuit - + Construct the variational form, given its parameters. **Parameters** @@ -38,13 +38,13 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.mdx index 8b44044f882..65c3a716ced 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase # OperatorBase - + Bases: `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -105,7 +105,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### equals - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -143,7 +143,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### mul - + 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`). **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### power - + Return Operator composed with self multiple times, overloaded by `**`. **Parameters** @@ -215,7 +215,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### reduce - + 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. **Returns** @@ -239,7 +239,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -261,7 +261,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_legacy\_op - + Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -299,7 +299,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase ### to\_matrix - + 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. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.mdx index 35ae8dafe00..354d867e3bd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.mdx index f520786ca64..7d23f01f9fe 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.mdx index ca51807c240..d1b1f422204 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.mdx index 8053614e1e9..35e0d17232f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.mdx index 49f46ff191f..3f2a214b837 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.mdx index 1984cf9a1ea..375e277a801 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx index d55eabac99e..441d103b8d9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.mdx index 544b5754497..a74eaa6117a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx index ed1d68d349e..7096815aa6c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 70008eddffc..b414ebc507a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.mdx index 38629cb322d..3597748905c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift # QDrift - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.mdx index 0d51887cb44..d9ecb3ad50e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki # Suzuki - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.mdx index 93db0f61340..036e2f90c12 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter # Trotter - + Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index 34ae6002646..52b858a4920 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx index 3aad16d1d37..3c630187687 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx index da4e371d1f9..19c6c955784 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.mdx index bb8c3de0464..f673d4ebe67 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.mdx index 1c3700e8777..cadd3c880da 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.mdx index 6795b9d8bbc..ef805ab5a47 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.mdx index f1e4176222c..2fe236a6f68 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.mdx index 3a6018906da..632fc594d4e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.mdx index a7327e44e85..f048a7a8335 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.mdx index 0bfdbf04e73..db85991aab9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.mdx index 6bd56bc19e6..35b5c9fdf05 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -65,7 +65,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.mdx index fc18de875f7..e4c10595f35 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient # Gradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.mdx index 009e7db36c6..e44c2be84fd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase # GradientBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.mdx index 5752da18ad7..e63aad1202c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian # Hessian - + Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. @@ -95,7 +95,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.mdx index 00a946d2f99..56c66197221 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase # HessianBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.mdx index f7ca7efcc59..850e9b1cd22 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -77,7 +77,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.mdx index 1aad7ff4fad..c17ed5bbdf9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI # QFI - + Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). @@ -70,7 +70,7 @@ $$ ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.mdx index aa6f14122df..8e6619bc01c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase # QFIBase - + Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -73,7 +73,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index 7ae719f1b69..ad1c096634c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator # LegacyBaseOperator - + Bases: `abc.ABC` Operators relevant for quantum applications. @@ -19,41 +19,41 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### chop - + ### construct\_evaluation\_circuit - + Build circuits to compute the expectation w\.r.t the wavefunction. ### evaluate\_with\_result - + Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. ### evolve - + Time evolution, exp^(-jt H). ### is\_empty - + Check Operator is empty or not ### print\_details - + print details ### to\_opflow - + Convert to new Operator format. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.mdx index 7ac3f7afa7b..8de3f523e9e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator # MatrixOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.mdx index 4d7d389194f..d43bc0ab342 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph # PauliGraph - + Bases: `object` Pauli Graph. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx index 424b0158386..8a450ff0dca 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator # TPBGroupedWeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` TPB Grouped Weighted Pauli Operator @@ -246,7 +246,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -281,7 +281,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** @@ -427,7 +427,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### sorted\_grouping - + Largest-Degree First Coloring for grouping paulis. **Parameters** @@ -495,7 +495,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator ### unsorted\_grouping - + Greedy and unsorted grouping paulis. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx index 9affe5f72cb..e12842aca91 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator # WeightedPauliOperator - + Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` Weighted Pauli Operator @@ -244,7 +244,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_dict - + Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: ```python @@ -279,7 +279,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_file - + Load paulis in a file to construct an Operator. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator ### from\_list - + Create a WeightedPauliOperator via a pair of list. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.mdx index 5d900e25ac2..129cdcb1c31 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries ### two\_qubit\_reduction - + Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.mdx index ce01ab9dd91..67721bf3695 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.mdx index 45b52c955eb..cf42d2f9e48 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp # ListOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.mdx index 341158f2a21..a27638803c1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp # SummedOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.mdx index 07abb514ca3..7d3ba79de8d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx index fae608410e2..70667b867bd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index cc0f9e32acc..4e034c91803 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index 041a8c01567..d45a822f6bd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index dcba818f021..d2f8e6dde9c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx index 61a7259a3b9..bb5714becf9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index e94241c69df..45248c10242 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -149,7 +149,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.mdx index ad8040977a0..7feeca20e57 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx index 16fe296b89b..4a4e01fdfb3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.mdx index ed74b7583dc..5437497d9f6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn # StateFn - + Bases: `qiskit.aqua.operators.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.mdx index 30e10867f00..4c0c59406e8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.mdx b/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.mdx index d7f8dbdc4fa..ecc044c4948 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory # CircuitFactory - + Bases: `abc.ABC` Base class for CircuitFactories @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory ### build - + Adds corresponding sub-circuit to given circuit **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.mdx index f1aa3759ed7..4abcc24e492 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.mdx index 14b70f34e1b..0e69b3e1327 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.BosonicOperator # BosonicOperator - + Bases: `object` A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.mdx index 755645ff9e0..a2531481b19 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.FermionicOperator # FermionicOperator - + Bases: `object` A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.mdx index aaef115478c..7d69301eef0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.MP2Info # MP2Info - + Bases: `object` A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.mdx index 929578ad262..614e61aa471 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QMolecule # QMolecule - + Bases: `object` Molecule data class containing driver result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.QMolecule ### onee\_to\_spin - + Convert one-body MO integrals to spin orbital basis Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.QMolecule ### oneeints2mo - + Converts one-body integrals from AO to MO basis Returns one electron integrals in AO basis converted to given MO basis @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoe\_to\_spin - + Convert two-body MO integrals to spin orbital basis Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. @@ -123,7 +123,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo - + Converts two-body integrals from AO to MO basis Returns two electron integrals in AO basis converted to given MO basis @@ -144,7 +144,7 @@ python_api_name: qiskit.chemistry.QMolecule ### twoeints2mo\_general - + ## Attributes diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.mdx index b71c74d9119..3152d6d8689 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError # qiskit.chemistry.QiskitChemistryError - + Class for errors returned by Qiskit’s Chemistry module. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.mdx index 76981917a3a..f7c6c8d4039 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian # WatsonHamiltonian - + Bases: `object` Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.mdx index 7d59ab47203..d6254e5bfeb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE # AdaptVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.mdx index e2dbdd024c6..6bf04ba3ec8 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.mdx index 7acf3e6d4e5..49fb5b86b42 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory # EigensolverFactory - + Bases: `abc.ABC` A factory to construct a eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory ### get\_solver - + Returns a eigensolver, based on the qubit operator transformation. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx index a0662dd68b0..5054491f56f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver # ExcitedStatesEigensolver - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx index 027fa1147f3..a8b9598a9d0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver # ExcitedStatesSolver - + Bases: `abc.ABC` The excited states calculation interface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver ### solve - + Compute the excited states energies of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx index b9b6ad6443d..4a910e2152d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver # GroundStateEigensolver - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.mdx index 3267792eda6..b7ccf1d806a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver # GroundStateSolver - + Bases: `abc.ABC` The ground state calculation interface @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### evaluate\_operators - + Evaluates additional operators at the given state. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### returns\_groundstate - + Whether this class returns only the ground state energy or also the ground state itself. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver ### solve - + Compute the ground state energy of the molecule that was supplied via the driver. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx index 8331af81f9e..8648cfeb832 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory # MinimumEigensolverFactory - + Bases: `abc.ABC` A factory to construct a minimum eigensolver based on a qubit operator transformation. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### get\_solver - + Returns a minimum eigensolver, based on the qubit operator transformation. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory ### supports\_aux\_operators - + Returns whether the eigensolver generated by this factory supports auxiliary operators. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx index 8dc4c0de270..d13cc425e53 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory # NumPyEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx index e89fb1a8975..45e182fe353 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory # NumPyMinimumEigensolverFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx index 0dc46d97840..9d0f0952027 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE # OrbitalOptimizationVQE - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.mdx index d92b8179a2c..03c18ce3b96 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM # QEOM - + Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.mdx index 78a74d31efd..5aff9c4972b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE # QEomEE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` QEomEE algorithm (classical) @@ -70,7 +70,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.mdx index 2eb99aada68..d5857a50e93 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE # QEomVQE - + Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` QEomVQE algorithm @@ -223,7 +223,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.mdx index 54dc2ad2973..74d85b7a88c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt # VQEAdapt - + Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx index 8fca437e6a9..d4a06ddeaa7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory # VQEUCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx index a63b36a8272..2c6ed355267 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory # VQEUVCCSDFactory - + Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx index 0b390840a9c..bd5d4b229bf 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler # BOPESSampler - + Bases: `object` Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx index a683fa04370..c0dc669f3c9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat # DifferentialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx index 27e410e16ff..b7275963137 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline # EnergySurface1DSpline - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx index 25f70a61af8..3525e0c6eeb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase # EnergySurfaceBase - + Bases: `abc.ABC` Class to hold a potential energy surface @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### fit - + Fits surface to data **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -72,7 +72,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -92,7 +92,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase ### get\_trust\_region - + Get the trust region. Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx index 8de6427da62..1de65277293 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator # Extrapolator - + Bases: `abc.ABC` This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. @@ -21,7 +21,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### extrapolate - + Abstract method to extrapolate point(s) of interest. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx index a0206544ee6..25f9ed9bcff 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential # HarmonicPotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Harmonic potential. @@ -80,7 +80,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### fit\_function - + Functional form of the potential. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential ### process\_fit\_data - + #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() so that only the points around the minimum are fit (which gives more accurate vibrational modes). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx index 5015706a5f2..c902bd422a1 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential # MorsePotential - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` Implements a 1D Morse potential. @@ -82,7 +82,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential ### fit\_function - + Functional form of the potential. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx index 615e12be689..ecf635421eb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator # PCAExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx index a3a29eb223e..27a27dae52f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator # PolynomialExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. @@ -44,7 +44,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx index 51dd046f4ec..c65d6156956 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase # PotentialBase - + Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### dissociation\_energy - + Returns the dissociation energy (scaled by ‘scaling’) **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### eval - + After fitting the data to the fit function, predict the energy at a point x. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### fit - + Fits surface to data **Parameters** @@ -62,7 +62,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_equilibrium\_geometry - + Get the equilibrium energy. Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. @@ -100,7 +100,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### get\_minimal\_energy - + Get the minimal energy. Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx index aff661e9ed8..052e9f0b416 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator # SieveExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx index b815a63e469..d3370db7f4a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase # VibronicStructureBase - + Bases: `abc.ABC` Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### get\_num\_modes - + Returns the number of vibrational modes for the molecule. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase ### vibrational\_energy\_level - + Returns the n-th vibrational energy level for a given mode. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx index 171d29acd52..a7adb5d18a6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator # WindowExtrapolator - + Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator ### factory - + Factory method for constructing extrapolators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx index a2fda7467db..269402d4ade 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy # MolecularGroundStateEnergy - + Bases: `object` Molecular ground state energy chemistry application @@ -50,7 +50,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy ### get\_default\_solver - + Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx index 12b0e129750..b4cb06bf40d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis # BosonicBasis - + Bases: `object` Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx index 21f29c60ca5..4d704c7766a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis # HarmonicBasis - + Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.mdx index 0477a2e77de..2ca5a0596e4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock # HartreeFock - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.mdx index ad1d3a4b809..e1a82a2acca 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF # VSCF - + Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.mdx index 0069a69dce6..e94b20d9231 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC # CHC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is the Compact Heuristic for Chemistry. @@ -57,13 +57,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.mdx index d766d177baf..f55983c9e8f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD # UCCSD - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists - + Computes single and double excitation lists. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### compute\_excitation\_lists\_singlet - + Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. **Parameters** @@ -133,13 +133,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### get\_entangler\_map - + returns entangler map ### group\_excitations - + Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### group\_excitations\_if\_same\_ao - + Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### order\_labels\_for\_hopping\_ops - + Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. **Parameters** @@ -218,7 +218,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### same\_ao\_double\_excitation\_block\_spin - + Regroups the excitations that involve same spatial orbitals for example, with labeling. 2— —5 1— —4 0-o- -o-3 @@ -242,7 +242,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.mdx index c562d5ba4f0..ced5cd3749b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC # UVCC - + Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. @@ -29,7 +29,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### compute\_excitation\_lists - + Compute the list with all possible excitation for given orders **Parameters** @@ -92,13 +92,13 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC ### get\_entangler\_map - + returns entangler map ### validate\_entangler\_map - + validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.mdx index f3b5d34f829..26ce880b1b6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator # ChemistryOperator - + Bases: `abc.ABC` Base class for ChemistryOperator. @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### run - + Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.mdx index c3d02503c31..8b77571600f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian # Hamiltonian - + Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.mdx index de6c15fb604..2b7a47f7d00 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult # MolecularChemistryResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` Molecular chemistry Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 28e1b45db45..d19d2e6800b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult # MolecularExcitedStatesResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Excited States Result @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.mdx index ed8e6534764..2d9ffbe9404 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult # MolecularGroundStateResult - + Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` Molecular Ground State Energy Result. @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.mdx index 666348dcaf4..78f73393146 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType # QubitMappingType - + Bases: `enum.Enum` QubitMappingType enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.mdx index 9392f1f0b1f..5abc45e71b5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.core.TransformationType # TransformationType - + Bases: `enum.Enum` Transformation Type enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.mdx index 7c6c9ab9cfc..4747a964ac0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver # BaseDriver - + Bases: `abc.ABC` Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.mdx index a7db32a28f3..073f583e8d1 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType # BasisType - + Bases: `enum.Enum` Basis Type diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.mdx index aff1c967000..868bbee07c2 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver # BosonicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry bosonic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver ### run - + Runs driver to produce a WatsonHamiltonian output. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.mdx index 1216408cf01..599da6276eb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver # FCIDumpDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an FCIDump file. @@ -34,7 +34,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver ### dump - + Convenience method to produce an FCIDump output file. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.mdx index e9f6b72ef12..2c42a3f2938 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver # FermionicDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Base class for Qiskit’s chemistry fermionic drivers. @@ -28,7 +28,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver ### run - + Runs driver to produce a QMolecule output. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.mdx index 5943db9b76d..0640d92fc2e 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver # GaussianDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.mdx index 85a7aecafed..7c8678b3ba7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver # GaussianForcesDriver - + Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.mdx index 4ad402137c9..b42232db85d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver # GaussianLogDriver - + Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.mdx index 08aa4bcfdff..9d9e7705241 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult # GaussianLogResult - + Bases: `object` Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.mdx index b1bfd83ed76..2983f4b353e 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver # HDF5Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.mdx index dc08dc847e3..162b3eb2516 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType # HFMethodType - + Bases: `enum.Enum` HFMethodType Enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.mdx index 08a7733eeec..c9820ee0f8f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess # InitialGuess - + Bases: `enum.Enum` Initial Guess Enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.mdx index a36d0286020..2acdd987aaa 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule # Molecule - + Bases: `object` Driver-independent Molecule definition. @@ -31,7 +31,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_angle - + **Parameters** * **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -49,7 +49,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_distance - + **Parameters** * **distance** (`float`) – The (new) distance between the two atoms. @@ -85,7 +85,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### absolute\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) @@ -103,7 +103,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_bending - + **Parameters** * **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* @@ -121,7 +121,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule ### relative\_stretching - + **Parameters** * **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.mdx index 5c6813a19cb..aedb8e779b4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver # PSI4Driver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.mdx index 97894cf400b..926f0304864 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver # PyQuanteDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.mdx index 362eeb690e9..a5ee29a3b09 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver # PySCFDriver - + Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.mdx index b66a5973b75..23b7a5bae69 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType # UnitsType - + Bases: `enum.Enum` Units Type Enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.mdx index d5bff92b6b0..75f25624bb0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult # BOPESSamplerResult - + Bases: `object` The BOPES Sampler result diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.mdx index 8d6bc9c45be..1524ed59c22 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult # EigenstateResult - + Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` The eigenstate result interface. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.mdx index ce464992806..9ad2a642d9d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult # ElectronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The electronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.mdx index 12a0c43f6e0..ead9f5c13f4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult # VibronicStructureResult - + Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` The vibronic structure result. @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult ### fromkeys - + ### get diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx index 02f6d520c2b..4a289e1ef83 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType # BosonicQubitMappingType - + Bases: `enum.Enum` BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.mdx index 080a2134680..44dd5f5c967 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation # BosonicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.mdx index ab2a11023aa..12e20b37cf5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType # BosonicTransformationType - + Bases: `enum.Enum` BosonicTransformationType enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx index c6edc0b9f8e..ff4e023ff8b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType # FermionicQubitMappingType - + Bases: `enum.Enum` FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.mdx index 9350be4572c..b14ecf68ea8 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation # FermionicTransformation - + Bases: `qiskit.chemistry.transformations.transformation.Transformation` A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.mdx index 6057596e1f1..32242e07ede 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType # FermionicTransformationType - + Bases: `enum.Enum` Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.mdx b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.mdx index 111d61a35ad..e74bb582df2 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.mdx +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation # Transformation - + Bases: `abc.ABC` Base class for transformation to qubit operators for chemistry problems @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### build\_hopping\_operators - + Builds the product of raising and lowering operators (basic excitation operators) **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### interpret - + Interprets an EigenstateResult in the context of this transformation. **Parameters** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation ### transform - + Transformation from the `driver` to a qubit operator. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.mdx index e60f961a777..e47582ab82b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.mdx index 9e027ef7a14..155d16095cc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.mdx index 2cd323170ec..ee67c6dbbb2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.mdx index 8742163072d..2408d0c4582 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.mdx index b3ca1f4682d..6be7c042a27 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Delay.mdx index e43ee362cb9..9256f3dcff1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.mdx index 651d72bda11..816820911ab 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Gate.mdx index 77f20409a2f..e3bb4de81e8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.mdx index 623dffe5d2e..c10723365bc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.mdx index 1b7ccd3f0d3..cd4813aa260 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Measure.mdx index da8cad9d7a2..bafd07ccd01 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.mdx index d7e431a9f44..f9589202387 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.mdx index 651174034d8..47bbf312381 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.mdx index 841f8fa7ea9..09dc0d53847 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.mdx index 157949fde44..1c755499f38 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -340,13 +340,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -762,7 +762,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -780,7 +780,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.mdx index 7d2c607e976..d6bdc91fd07 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.mdx index 93f7ea5dc0f..cf400cfe296 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.32/qiskit.circuit.Reset.mdx index c685f9c77a8..fbf9b90ccd7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 8bcbf85ae5f..32565987ed0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 2f0d39e7816..5f28d3fd55b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index c5f63a79721..8746dfcea75 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 68e24fb0a52..1c216593b03 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.AND.mdx index aae6d1662da..08c3368aede 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.mdx index 5ec7657d560..10ed222937d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.mdx index 471b65e9eaa..e123f194577 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.mdx index 068492e37b1..666c938d95a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.mdx index ff67e0fb9cb..b1f9f816f80 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.mdx index 2a81088aa70..17cd9845d20 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index d120d3e0db9..c4f9d926524 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.mdx index 97b16435712..bf6c0da7a96 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.mdx index 6cebdde31dc..d52a658510c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.mdx index bd2447ddf5c..ab0bc1546df 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.mdx index 8b83153fa3d..a86a9329f07 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.mdx index 89064272392..f8f7814144a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.mdx index 00737bd9d36..082e5838b5f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.mdx index cd20a5736fa..211d99aa74d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.mdx index ae6885f5be0..40672693ada 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.mdx index e49b6e7c11f..16deee0f985 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.mdx index 612d0d89207..7459bb2291a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.mdx index 0f8eb3e9b60..7c63ea96316 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.mdx index 428538007fe..ae7f4cd903e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.mdx index ff804eedc5c..6a34cd3cfe2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.mdx index 733ae6e1174..6150234bdf4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.mdx index 1bad671175d..21888cd13e1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.mdx index eb2b8f5ce77..92c71676148 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.mdx index 3e8e9d89928..4c6c5e3806d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.mdx index 81befc09631..035079ea0fe 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index e4cb2e7a4d9..408c134706d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.mdx index 528cb5941b4..61fc022081b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.mdx index 281d6a53ad3..031344a660d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.mdx index c9fb976b93e..721b89664e8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.mdx index 2aa3a21728f..9deb3192ef8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GR.mdx index 3d35154102c..71bc9a838e8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.mdx index be85fb70614..ce7ee8030a0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.mdx index 6a8539d7213..1e57f686328 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.mdx index 7b45706325f..f81a261f956 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.mdx index 9a0a8d4fa1b..eadfe9250cc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.mdx index e64f9455368..5334bb15cb7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.mdx index 4e7be8b3485..fc616994cee 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index c712a8b1ca2..cc6f25936bd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.mdx index d1fa5bc1a04..dc68b0ad37e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.mdx index bbe9cd36e7c..daecfc664c6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.mdx index 22b02f2ea62..76ec39ada3b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.mdx index 4d4155bc246..eca93ad60f3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.mdx index 608168ff59c..7d602c274e5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.mdx index e3dd9e3f0d3..634d578d7a5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.mdx index 7a1eb0cdb05..59417e3e4bd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.mdx index 6ad70a48e7e..81592cfa921 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.mdx index 7209542a00f..1b1576d5e9d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.mdx index aae13bd190e..50662cbe4a3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.mdx index 10bd3fc657f..636244be9fc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.mdx index 8aee00f1a45..ef62d61bb74 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.mdx index 139c6d4cb8a..0aef8882f4e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.mdx index 83de799f5c7..0a25b85a0de 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.mdx index e236d61fcf0..8403196e4d8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.mdx index 1d5dc918cb9..6c46c743963 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.mdx index 5fc86d31022..dc2c6961452 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.mdx index 3f629df8ab9..20f6fefa821 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.mdx index 77bb89c4c35..ee329f61bb8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # NormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.OR.mdx index c6bebd0214b..5862a0b52ac 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.mdx index a3344152d4b..dab5273262b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.mdx index 41cc1f8a31c..6c26563d6c9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.mdx index c74fc599567..daac5d40a87 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.mdx index b50c92857d3..0db231e12a6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.mdx index 536082ceb6d..1b3a979a99b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.mdx index 1e1f5fe65aa..b6696b68f9e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.mdx index 4ce585eb7a2..ef39cdfd5d8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.mdx index 1fd7bea34dd..6cd630569e0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 7869b940f22..7b195724d43 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 6b8ec05bb79..34e828e2f3f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.mdx index 8d2108ee68e..ae353d11676 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.mdx index 5001376e2b7..ac6b6ef75c7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.mdx index 7d172a9c0d5..79b9f3aa65c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.mdx index 10d6a1992ad..2516d78e22b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.mdx index 622f7e34f89..702002f1628 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.mdx index e765a279443..0db3a0f9e2b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.mdx index 1735b1b0e90..963ac994d72 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.mdx index 145e1a19d88..d28a5bc44fb 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.mdx index febbde25953..486941396dd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.mdx index 4e387b6353a..cf5f45608ef 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.mdx index f37a6592f72..de8afd18c2c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.mdx index a4ce87e1bc7..d0906b419f3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.mdx index 5fcfa9cd0ed..4c06fd205ac 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.mdx index a44258ef907..6e8e8d56282 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.mdx index 4fa70db923b..512e12e89a0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.mdx index af89584b29c..c1260d87b78 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.mdx index 7e51b7670c6..3a796a0a655 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.mdx index 704c0d7ba04..b03a3e1f4c2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.mdx index 3eef29d039d..7d80ece1a58 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.mdx index 63188080383..458f10b1f10 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.mdx index aab13bfa833..b4889a59440 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.mdx index df31e9a2384..14eb9de8c51 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.mdx index e3e0e5626c5..e10f453cba7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.mdx index a9011593cd3..9cab7c51fd8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.mdx index a1f033cc5aa..7eef8140bb3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.mdx index 5718062f000..90e6226eff3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.mdx index 8bfc12282f6..2f7a8e08058 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.mdx index 1ac3846ca02..3e67dfd31ac 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.mdx index 9b88878b07c..495b2e00c43 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.mdx index 4074cf925a3..95252b4175a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.mdx index ee8b10cc227..a2735f93635 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.mdx index 5335f5df3f2..f436b5c3122 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # UniformDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.mdx index a64b8bdb714..7c4d1d57d2d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.mdx index 0dcfe94e82d..36497bbe0e4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.mdx index 42b392fdb1d..460485d15ed 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.mdx index ac3957934e3..0e7ddc697b5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.mdx index fbbc51ee788..f7fad5ed841 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.mdx index bc889bd5caa..463fac676c1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.mdx index 2f7edd290e0..4f0c40184c2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.mdx index 75aa982bf0f..705e7880612 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.mdx index ef7aa70fb20..455b12f2a95 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.mdx index 41c943cb863..bc021697fd1 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -257,7 +257,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.mdx index 74f1ba48a24..011f90528ed 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.mdx index 83e4ac1a1d4..f7d2cc4e0b8 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.mdx index 2cb2674edfd..60b0855825c 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.mdx index 838039d329f..61c5a3da024 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Object to represent the information at a node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.mdx index 3fb3afe478c..8bdaa059049 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.mdx index 2f3978fe2dd..8ad775b6a7b 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.mdx index f62fefcea9d..7c4483b3fa3 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.mdx index e8882b47179..86f03620389 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.mdx b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.mdx index 7bb360e35a2..36e35864bdf 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.QiskitFinanceError # qiskit.finance.QiskitFinanceError - + Class for errors returned by Qiskit’s finance module. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx index 9f1837295fc..2d456d2c7ac 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt # EuropeanCallDelta - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Delta. diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx index cfaab07cd5a..1f4c494db7d 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe # EuropeanCallExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx index fd50bef69be..6e98b4e9cca 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec # FixedIncomeExpectedValue - + Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.mdx index 7ab21f7e4b2..e85a4d89430 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider # BaseDataProvider - + Bases: `abc.ABC` The abstract base class for data\_provider modules within Qiskit’s finance module. @@ -121,7 +121,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider ### run - + Loads data. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.mdx index d9d6253096a..d8110b835e2 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider # DataOnDemandProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.mdx index a4e6691270f..389c570e825 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider # ExchangeDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Exchange data provider. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.mdx index fc5d311e67d..a1c4aca6fdd 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider # RandomDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.mdx index dd09960bba9..824586df72d 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket # StockMarket - + Bases: `enum.Enum` Stock Market enum diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.mdx index 6ef858ed112..770eb99bcb0 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider # WikipediaDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Wikipedia data provider. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.mdx b/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.mdx index 9b794c8d7f8..b9ec38bc96e 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider # YahooDataProvider - + Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` Yahoo data provider. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.mdx index cd05419fed3..05559c16c31 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.mdx index 35c8a1f8cda..cb92ec9c3b1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.mdx index e2a89865c05..e4c187fc67e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.mdx index 471990a07c3..7fc9bf54c70 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 2cb64c711ed..907ea65daa7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.mdx index 796c8ad4114..cba2388ba9a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.mdx index d48de97f326..dbcf94e40b7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.mdx index d9f67871d54..7bd3b0e303b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.mdx index 78d0b83b466..d807ec2f107 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.mdx index 96080ca5386..5ef118f9af9 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.mdx index 9d2427a8ffe..0a72032970b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.mdx index 26dc2c9fa22..82c89cffd5d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.mdx index 37b8b831ae2..9bbcb2f8e2b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.mdx index c0fb4f02719..1d904cf6d1f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.mdx index 4c32dcdd7ab..6ba1b091dbb 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.mdx index 4b68060ec45..6a25583bf86 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index a618b199d11..161b844ccc0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 478ad70845e..5aeff445ff1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index ff2dbb2f975..6fdbc42bfa7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index eef37cc454a..c46b2f5c2fc 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 8048a03f161..41360446c85 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 047b5fb7e9b..dc5f46377c6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 1d4689c9640..a88584c6401 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 378183cec6f..12fe0816a7d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.mdx index c87a2d0c724..40f693d31d1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index b10b5ddb96e..0f8fb908ad5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.mdx index 640f0f02bde..ce42be2f0c3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 54a4c0a6834..69caa71c49e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.mdx index dd4034ae2ff..355df13ef86 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.mdx index 43306903dd2..96b8c74f4d2 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.mdx index 1472cd43dbd..94622b107aa 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.mdx index 41ef30dd784..20201b456b7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index c24f99de034..96eeb848007 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.mdx index b90f47dbf0c..1ce31cc35c4 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.mdx index af9c13ef001..f9cda6c23ee 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.mdx index 3d69f841152..fcb8721075c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.mdx index 90f03443e78..6ffe80939ea 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.mdx index d3c3debf0cd..711f5553506 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.mdx index 2ae6db88219..2adfadd93f8 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.mdx index 7f291d2d3ab..e95ddfe13f2 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.mdx index a7f21ebbf32..d2548d72895 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.mdx index cfd9db2f212..c1640cd317e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.mdx index 8f3f0e35819..2025a3632d3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.mdx index 222e4029b77..7698bd99556 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.mdx b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.mdx index 9a59d30918b..c099f376c37 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.mdx +++ b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector # RawFeatureVector - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The raw feature vector circuit. @@ -128,7 +128,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -164,13 +164,13 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. ### cls\_prefix - + Return the prefix to use for auto naming. @@ -586,7 +586,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -604,7 +604,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.mdx index 38d34b8c4df..149f4da528a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -207,7 +207,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -221,7 +221,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -253,7 +253,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -271,7 +271,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.mdx index 69c8f8acafe..dd70307cb72 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.mdx index 06b358eb294..27943a01229 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.mdx index 09d211423d7..a14f211dacf 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.mdx index a1f404e66b6..d103f696cbd 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.mdx index 2febdbcdc38..abe43a3e1ab 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.mdx index 3e7b05568cf..89f3698a1b7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.mdx index a2f9bc6ab12..1c6277cf6d9 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.mdx index 62e25e5412e..91bb9242c96 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.mdx index edb1f84d31d..4672e9e401e 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.mdx index 05af3b167a5..e6df4af3f09 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.mdx index 71d69092bd9..8b40ab664bb 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 6dac1bf3e20..0b8fe14fa33 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.mdx index 7ae4eed0cad..cd627826f11 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.mdx index 4bac8192c57..0d488be1b0c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.mdx index f19c6dedf5a..21699813034 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.mdx index d079c7dd33d..e314c4fc169 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.mdx index ce855140e8d..2601f58f901 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.mdx index 4aae59be22e..8e217c67c77 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.mdx index 6980e6d35d2..fc28ef6e490 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.mdx index 3bed350ae77..d75ae9f84f2 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.mdx index b0113af7825..341e9b4bdaa 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.mdx index 12acacdcaf7..ddad236dc9c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.mdx index e13e6fc2334..f8e0180659c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.mdx index 703b3aaeb23..4a8d87ccdf6 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.mdx index bd0311e7447..49a214c9a5b 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.mdx index 64aeb6d9cb8..5564b3d7f76 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.mdx index 0fc3150a6db..b3b61f5b5d1 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.mdx index a7e6e41a3b7..72a2c8000af 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.mdx index 4e19960c313..657d9e11304 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.mdx index 6ae5d1076cd..30e6dde2580 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.mdx index 79bceb8ff81..5deb277c4be 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.mdx index d4e81349854..78ab225933f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.mdx index 8223f03d774..9fc0b7412df 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.mdx index cb8494bf088..af8278bcf4d 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.mdx index b68bc55be03..5786e23fbd7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.mdx index 503f03e3a0c..6be32eaa7c9 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.mdx index bf50c72e85f..06811dc1c54 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.mdx index e997228c2d8..d479c1d1de7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.mdx index 394fccc90ab..e102b212a82 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.mdx index a266dfe0bbc..0a86648c03f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 53af0f3650c..e848d4068db 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backend by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index a3be025a6cd..e434d9ceb5f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 72b3f09afaa..ed3fa6516ee 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index da8ae03d781..1e18b9e151a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.mdx index ab08acd1f26..1eaf5b5fb9a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.mdx index 0bfffd6d323..b6b630d8622 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.mdx index bb30f9f1f3c..c0d39647960 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.mdx index b0a37588316..7edc0986e2a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index e0a6fd4b332..6b67ad6964f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.mdx index 5af81f4c8c6..75fc14d028c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.mdx index 3559ebab3ec..19969315164 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.mdx b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.mdx index 5a3c246fcfe..da2d10c2205 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError # qiskit.optimization.QiskitOptimizationError - + Class for errors returned by Qiskit’s optimization module. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.mdx index f91cf3e8057..37b7c663f62 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx index 51bef8ac0f3..dceed501e26 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult # ADMMOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` ADMMOptimization Result. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.mdx index 5208dfcc02f..79a48670ae4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer # ADMMOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.mdx index 77872f382be..692c38c30d5 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters # ADMMParameters - + Bases: `object` Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.mdx index 40d6017d6fc..d6028e94257 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState # ADMMState - + Bases: `object` Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.mdx index ea5943c1a0c..3430d5be0cb 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer # CobylaOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.mdx index 227e3cca202..8bfe276e2d7 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer # CplexOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -78,7 +78,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### is\_cplex\_installed - + Returns True if cplex is installed diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.mdx index d78d9e123c8..56ed0bd1297 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult # GroverOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.mdx index 0be7733aa22..20c4a257e26 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer # GroverOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.mdx index 971f2fe4fc1..fcb45add97a 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult # IntermediateResult - + Bases: `enum.Enum` Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx index 69b81353b66..329d902f358 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult # MinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx index c81a65e4e0d..26221a7b870 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer # MinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.mdx index 975756bf3a2..d7b755212ad 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer # MultiStartOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` An abstract class that implements multi start optimization and should be sub-classed by other optimizers. @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx index ba9d9e23142..4a55a766f83 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm # OptimizationAlgorithm - + Bases: `abc.ABC` An abstract class for optimization algorithms in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### get\_compatibility\_msg - + Checks whether a given problem can be solved with the optimizer implementing this method. **Parameters** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm ### solve - + Tries to solves the given problem using the optimizer. Runs the optimizer to try to solve the optimization problem. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.mdx index 0cddaaf87f0..2fd25e78252 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult # OptimizationResult - + Bases: `object` A base class for optimization results. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.mdx index 69057e9376e..e74eb11bd7b 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus # OptimizationResultStatus - + Bases: `enum.Enum` Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx index 616b8f64191..3dee30e4fa4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio # RecursiveMinimumEigenOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx index 6333eedba90..d0252360631 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer # RecursiveMinimumEigenOptimizer - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx index e18a64f6263..9aa5efdf8c9 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult # SlsqpOptimizationResult - + Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.mdx index b08d49889fe..a42fb7f32f0 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer # SlsqpOptimizer - + Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.mdx b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.mdx index a8f260f993a..3cb785a2b39 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample # SolutionSample - + Bases: `object` A sample of an optimization solution diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.mdx b/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.mdx index cf48c3a499a..03dded7cc15 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality # InequalityToEquality - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.mdx b/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.mdx index da4d1c5a0d3..db9b19e4920 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary # IntegerToBinary - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.mdx b/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.mdx index c68ef9a78fb..47597b8cc71 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty # LinearEqualityToPenalty - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.mdx b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.mdx index 4768a441cb3..4cfbd2cad5e 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter # QuadraticProgramConverter - + Bases: `abc.ABC` An abstract class for converters of quadratic programs in Qiskit’s optimization module. @@ -17,7 +17,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### convert - + Convert a QuadraticProgram into another form and keep the information required to interpret the result. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter ### interpret - + Interpret a result into another form using the information of conversion **Return type** diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.mdx b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.mdx index 14232d52624..76c36b0b3b7 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo # QuadraticProgramToQubo - + Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` Convert a given optimization problem to a new problem that is a QUBO. @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo ### get\_compatibility\_msg - + Checks whether a given problem can be solved with this optimizer. Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.mdx index 62dc54b369c..9a07e8e12e5 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Constraint # Constraint - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Abstract Constraint Class. @@ -26,7 +26,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### evaluate - + Evaluate left-hand-side of constraint for given values of variables. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.mdx index 6ab377f4fd8..687e040c0cc 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint # LinearConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a linear constraint. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.mdx index 25c1c8a747d..76733cff526 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression # LinearExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.mdx index 047bb47877c..1a56fe27952 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint # QuadraticConstraint - + Bases: `qiskit.optimization.problems.constraint.Constraint` Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.mdx index 82dc22dda07..e593560cdcb 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression # QuadraticExpression - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.mdx index 3e44d3e0e65..170ea1222c8 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective # QuadraticObjective - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.mdx index c8ba5b87a39..c3a0e312d1c 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram # QuadraticProgram - + Bases: `object` Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.mdx index 6541045e346..99f1d864f19 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement # QuadraticProgramElement - + Bases: `object` Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.mdx index de3b48f2933..28ab69d31fd 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.optimization.problems.Variable # Variable - + Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` Representation of a variable. diff --git a/docs/api/qiskit/0.32/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.32/qiskit.providers.Backend.mdx index da3a7652b55..5e05195f14c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.mdx index f69330f7c6b..72a40076aab 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.mdx index bd36632dc3a..f8006dd85c3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.mdx index b16a7eb6418..b5cbfd97b58 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.mdx index c9c50736acb..d4d52ea1329 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.mdx index 82bcb368239..215c5de8291 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.Job.mdx b/docs/api/qiskit/0.32/qiskit.providers.Job.mdx index 54ecc0c89b3..6508be69518 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.32/qiskit.providers.JobError.mdx index e0b4465d8da..9288a244b73 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.mdx index 26d97f65d9f..21cece14df9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.mdx index 0662d1b43b0..3034325f70d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.32/qiskit.providers.JobV1.mdx index e696713dfec..19f7a2ac088 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.32/qiskit.providers.Options.mdx b/docs/api/qiskit/0.32/qiskit.providers.Options.mdx index 30143726dce..e2a64db46ab 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `types.SimpleNamespace` Base options object diff --git a/docs/api/qiskit/0.32/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.32/qiskit.providers.Provider.mdx index a1e4820a314..41a8286de36 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.mdx index ccd9e916034..9f6a4375441 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.mdx index c9eed91c692..c8399f862b8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.mdx index f5d45324e73..f86276b2b55 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.mdx index b0f97a7b4b5..9b6b15cd19d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.mdx index 1ac5ba580ec..36e5147d082 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -203,7 +203,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.mdx index 39b6b410f58..3bb0292b6c2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.mdx index 4c70ed73f8b..2ab073beb25 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.mdx index e1deda88448..d79a5cbc884 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.mdx index af36737f947..4de66c199e2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.mdx index 55f3fecd6ee..75c584658eb 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -92,7 +92,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 956dc81fa78..032ff2abb66 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index e6ba2e0b979..7b3b9bd0e30 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 45484f453a9..be630210442 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -90,7 +90,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 3fa086b7f9f..f5ed53ce05c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 035119c2653..c0493cab342 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.mdx index e8d0f031bd3..447011556f7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.mdx index 0b968f7c1d0..35fface0455 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.mdx index 4b3c327f2b5..13c5db051f2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 85eadc1d527..fbceab7db97 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 687c86423d2..b5cd3012899 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.mdx index d8e93822c50..cf0e9be7f3d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index bf8b482a55a..c731e70a1ae 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.mdx index 0d3d5fb38e0..d75cf11c4a5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.mdx index c5fbc3073b7..da2d0dd18f2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index e9910051e9f..0bc92eb7fad 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.mdx index 9919d798541..fb243b689e1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.mdx index ca0424db96c..d6ac2638997 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.mdx index 2c09133118d..3728e10f193 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 625d7138068..54df40d0906 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.mdx index 4e282a0fdac..7d24905be18 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.mdx index f8a9573ca3f..fa3adb49c42 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.mdx index 66727e2448a..a3524b1ea67 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.mdx index 2f707161b99..96b835afea5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.mdx index d3182a6f85f..2aac219d97f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.mdx index 36f8e6b3971..10a18500db1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.mdx index 0e98c4261df..40566ada3d1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.mdx index ca5dd902eab..52045e58a17 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.mdx index f42e7bf27b0..dac95973dcd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.mdx index a5c7ee1c806..a0219f8d41b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `object` Quantum error class for Qiskit Aer noise model @@ -180,13 +180,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.mdx index d8f483dbd02..6ab625de8c6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -153,13 +153,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 5d1fec56e1e..b6ec7e26958 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.mdx index 077844871bd..7fcfa708655 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.mdx index bd5d2c2b441..1d4d1312c2e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.mdx index a2c3bb842db..34e53bdba4e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.mdx index de74083a1a2..b37d065031f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9314006cf7d..78f741cd891 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 43cd26238a7..f6e9ed4ae0a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index e1c871e48d8..e7433a01f51 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.mdx index 4a670091b51..1052c25fc68 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.mdx index f900db51eb4..53c31365501 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 8d918aa62b3..5c728ef20cb 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index a453510f0f2..a35140282d8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 3e26eddd42e..e125fa9e9df 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 2cf7ed39d47..3d5bff03d99 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.mdx index 82d9ac47109..92658ea4564 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index a8e422d14f2..000f3bd4cf5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.mdx index c8d8ee5618f..544d0d63f61 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 43dc150ff74..ec43b2905dc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index b2d564519e6..8d75a71b7f3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.mdx index 6df2d95f50f..ec2291dc46b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.mdx index 4f172af2bfe..2ea1738fa28 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.mdx index abbffce7184..bb307049ee2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.mdx index d6b5f5c6fce..56a59ac03e4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.mdx index 8ad154d44f2..4c320b46cbe 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.mdx index 56c6ab05c41..dc22e0d02e6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.mdx index ed11ff8dd24..0065028662f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.mdx index bf480c87e1f..c66be14c3ee 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 30a76743686..621f3494055 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 78bb642951f..ecf75b7d0e9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 576fc29424a..6b8ca6fb117 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 4113c397932..b83c50b7de7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index c2d848ad6e5..869549f328f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 20898a3fa32..ee4d19b90fb 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 940a11d4564..0d1d5ef2025 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 46f5a935655..467044de149 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.mdx index 2aa40b203a4..cc4c36557e2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.mdx index 617697ad076..ce626d8b90c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index c4f1c74269b..1cc29caf820 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.mdx index c877ffd03aa..da537c0a4f7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 98ea0a611ce..cc4e01adc56 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 1dcbce8fe12..fd998735e0d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index e7bcd366c4b..544fb71e613 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.mdx index 549739042fc..8044e89b37f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 9c576b62ded..31b54d952ec 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 96e28ed15f0..1661f69998a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 43bd6a25f6f..4821615a3d5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index e03108b13c1..d515af277fc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 4a341dea061..4b7c98d62f4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 313e10a4be3..274bc021428 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 085f7b1ca71..f50a6843609 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.mdx index b78917c3e65..9899f580860 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 703df2cab0b..ac41145d0b3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.mdx index e557169ed2a..1a1d70a0960 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.mdx index ef234f4b144..dc618f937e9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index acdcf85aa26..9206ccd16ea 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.mdx index caec51020ea..ed6783d51e1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 495164f87b1..4e1e77e8628 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 7525c0e9002..8398f392b63 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index 11078eeea8a..63b1b5a8d09 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 09f8f25b785..4833d689406 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index bf022d29afe..a1a5ba50da3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index b955744d1b8..4958435d203 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 383cec5ebfe..a71186b0f4a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 57e890bfbcd..9edfed69aca 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.mdx index a4a704f06ee..6c1801aa2b7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.mdx index df3eec4af33..e918da4236c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.mdx index 77d1fdc8179..1c4bde79839 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.mdx index 21e87bf2375..721c21747af 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.Command.mdx index 16a2ea5505e..50cd1f6bf55 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.mdx index 13586a9d476..de60478e5a6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.mdx index cb44704c9f2..47616218175 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.mdx index 237830bbcb9..7e6ba952bd2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.mdx index f94da9524c7..ec2aa302e11 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.mdx index af5fb36db89..9c26f781764 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.mdx index 007d38dcc2a..6c09d232fda 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.mdx index c46affcf243..eaeab81591a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.mdx index 3b4390572c3..c5d06bd8ed0 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.AcquireChannel # AcquireChannel - + Bases: `qiskit.pulse.channels.Channel` Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Call.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Call.mdx index f151ba8efd1..47fb7c293de 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Call.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Constant.mdx index 03b3cf4f08c..0f0be66e7b3 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.mdx index d3d4550a91a..03b83c73efa 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Delay.mdx index 6274766068b..72ede7938b6 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Drag.mdx index d641be206ca..69cfb7778df 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.mdx index b0c081287e1..6342fe06263 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.mdx index 7239447283c..e3140a854d3 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.mdx index b7627fb089a..edf5e9e1848 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.mdx index 12dcbd180c2..7887bd36a08 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.mdx index 34ab0f5aba0..97d2b9a6ae5 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.mdx index 2406d6ddad0..5ffae39cddf 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.mdx index ed27d7e5171..a1667df5ff0 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.Channel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Play.mdx index e1d51dadbcc..72d5412bab9 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.mdx b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.mdx index ca8a63aae19..6c4a5209ca4 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.PulseError # qiskit.pulse.PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.mdx index 8b413549bda..22d9d2534cf 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.Channel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.mdx index 140ab9fc9f2..1c77775f356 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -296,7 +296,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.mdx index 8b97bfbb906..88da85b43ff 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -295,7 +295,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.mdx index 8fb5f108629..c3335f82fa3 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.mdx b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.mdx index 3e5d6200fde..de3cdce12bb 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.mdx b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.mdx index 93e46a07f22..9c9c766c12f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.mdx index fb79ac431eb..75edfdeaf40 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.mdx index 90858c62fda..5db8a3ef85f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.mdx b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.mdx index 780d837b6f8..9af0eb34e13 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.mdx index 0abccea3dab..501f81b2380 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.mdx index d639c707f65..8cb6fc9b292 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.mdx index ea1dc87c499..ccbd34db68f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.mdx index b593356bf32..dd7c65e99d7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Instruction # Instruction - + Bases: `abc.ABC` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.mdx index 0034967f27b..8b8ea86fed1 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.mdx index 984cfc81cd8..7cec9fadecc 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.mdx index b8f649e8eb0..9edbe40b8b4 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.mdx index 1b16be0b1a9..c2d69b0cb36 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.mdx index 50892b62692..a6831d826d5 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.mdx index 6c3dd77ea24..c350a17086a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.mdx index 4184f268ebc..52e3da88aad 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.mdx index 80b66d60df7..bf98cdf5146 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.mdx index 2c61e27b4f6..f8b4d22ee56 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.mdx index 7182421becf..1b342d82041 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.mdx index fcd2b6c9539..da3b290edef 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.mdx index ff87cec855a..6aa25cb8683 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.mdx index dfe2bc265a3..ee416b485d7 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.32/qiskit.qasm.QasmError.mdx index 1fee3b72dd5..d644aafdce6 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.mdx index 3175a24235e..8a75e46f579 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.mdx index 07db1b7f478..94b7bc6e13b 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.mdx index 787f8e54b05..8ba473f21c7 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.mdx index b0dcded88f7..961f5fbc5eb 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.mdx index 6b0bc938ddf..1de601a7622 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.mdx index d615fb5e98b..7b584800b3c 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.mdx index 7f014f78fc6..0d2e71ac736 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.mdx index ed924abb218..aef0f5c9e38 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.mdx index 0938a0f479e..7eff2daa6b1 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.mdx index 6ab7b245f1a..760936cb3be 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.mdx index 492c4cb275d..ff4d9d86086 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.mdx index 5266d26b602..d6375345104 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.mdx index 5aa7935b61b..3a9b20709a6 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.mdx index 376ce1979d4..69f33477d2f 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.mdx index 645337a5946..4670a95d788 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.mdx index d3b93718154..304342d2ccc 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.mdx index 3a4e3bb91e3..61c2b439545 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.mdx index ae6aca77470..3b48e646c30 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.mdx index f7a32cf39ac..dcf3049a9ae 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.mdx index 23558fb64bd..f1eee674849 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.mdx index 63f21af5c05..3defd7bf44e 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.mdx index 79e5803cb2a..7ab00722f55 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.mdx index 76eb29b3662..d111340e1c3 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.mdx index c8ff5f7a644..c7794c4a04b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.mdx index f0ab29c1830..2cf7a5617cb 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index cbcc74d4a49..e5814f3fd96 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.mdx index 3aa2cc46607..f6427a78321 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.mdx index f04a63d5a70..39e99d5a841 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.mdx index e9c62f99e8d..947d1c69b25 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -335,7 +335,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -455,7 +455,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -497,7 +497,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -542,7 +542,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -556,7 +556,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.mdx index 4f1584cec13..d4d9375d5e4 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -363,7 +363,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.mdx index f278c2df387..c677c9552ce 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.mdx index 93182821c26..890fd2e73d7 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.mdx index 268a8a27469..987aa2217b8 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.mdx index 97088458d15..c7f0fe360f5 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -121,13 +121,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.mdx index 2b24f2e06f9..e017c9a2518 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.mdx index e1998b19bcf..c03d7a3e1d2 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.mdx index e3f122155ac..9e9ec1833cb 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -178,7 +178,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -202,7 +202,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -228,7 +228,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.mdx index e6bae9cd6ea..0b106b77207 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.mdx index 435e5f7f66f..4a3d460e981 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 364a3315218..2306ef07ff4 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.32/qiskit.result.Counts.mdx b/docs/api/qiskit/0.32/qiskit.result.Counts.mdx index 158a1a4df8e..9b1b034e6d7 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.32/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.mdx index 72cdecfa8a4..f6b6bfcbe5b 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.mdx index 5244c68e1a8..64583f12b9d 100644 --- a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.32/qiskit.result.Result.mdx b/docs/api/qiskit/0.32/qiskit.result.Result.mdx index 4501570076e..ef166e7a2db 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.32/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.32/qiskit.result.ResultError.mdx index e80c051198f..9a2fb418993 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.32/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.mdx index bceabdb134a..e8dfa7d43f6 100644 --- a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.mdx index 0103bc72544..ba5f7702eb5 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.mdx index 665aa86e542..a685ebc5325 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -89,25 +89,25 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. ### from\_grid - + Return qubits connected on a grid of num\_rows x num\_columns. ### from\_line - + Return a fully connected coupling map on n qubits. ### from\_ring - + Return a fully connected coupling map on n qubits. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.mdx index 2dfb47712ab..552fc450f13 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.mdx index bf8cd388da6..bf46d7cb7bb 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.mdx index f3487c8d57f..afbf44b10fd 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.mdx index 4531ba5634b..d1c89542d6c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.mdx index 66dfdf1dce5..8e3a6f04683 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.mdx index dc44aadcefa..7d3750743a1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.mdx index 0fdb65ac9b5..373ccf1770b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.mdx index 1424acdfdf1..b78cd0675ff 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.mdx index 7454bf8f37b..83a209c7b15 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.mdx index 32abb7d32c7..f5e7ba9af8c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.mdx index 39abe7bc7fb..9eb783e480a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.mdx index 38295935694..d125742b206 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ALAP Scheduling. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.mdx index 51ceb2dfae9..3d6ff6d7001 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ASAP Scheduling. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.mdx index e293cbf19db..b54daca5578 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.mdx index 6897f1689f8..34c0da5a1e2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.mdx index 78dad80e642..3c33be38436 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index d1fa3c2c55a..4600bbcdae9 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.mdx index 530cfa152a5..655038ed913 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.mdx index f688563cdda..83bba6c76db 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.mdx index 54cf75273fa..2ad60c74a37 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.mdx index a18492dcbfd..99943f34bbd 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.mdx index 3d66a5832ab..a54d042e870 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.mdx index 1db8bb2062d..6d4ed01da2c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.mdx index 2cb436c3808..aaa868860b1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.mdx index bfbc0df66ea..f211a83dc2e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.mdx index fba6454cd0a..b77ba82085e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.mdx index a9b9525387c..ff1007a7e23 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.mdx index 5e26bc707ec..736f9f68af4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 2d6dd13bc91..1e3834dc7cc 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.mdx index e5fd169cc9f..df56f82a5a4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 147283b7486..735092c4c2e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 71908291200..77d3f828d3a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.mdx index 80f41d00250..77f9737e21c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.mdx index 616bc9db666..ffdbefa4bfe 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.mdx index 801dda46e8e..2148594fe22 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.mdx index 21b01bea5de..67f62e2503b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.mdx index 51b17f3e8b1..8587a9fba15 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.mdx index ce74499e3db..787812f2b62 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 909b96f0577..9930da83fe2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.mdx index 3b5f740f6e8..137acd1f151 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 509f1962490..d63279ef495 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.mdx index a6011195098..d69ea681de9 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.mdx index 7d156d59295..c41c95d13d1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.mdx index 00eed73c469..2a69348ebf7 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 6afee12337a..3c21d1749b7 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 99ceb9d7892..1aeaf747b3a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.mdx index 598751f3e13..111e4e445a1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.mdx index 464a43468d3..1e39bc9f9c4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 37570f0c4aa..24d9a6ab333 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 561f6872895..b42550a839d 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 30991351e79..f74732a93b6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.mdx index 0b87683ad62..6080ea54ee3 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 1f34ed4cbd9..f180dc84fee 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 84cf5091c36..d074850769c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index a58a5f616e6..9a9854be12a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.mdx index 64cce077218..0bdd1e1f7e5 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.mdx index 304378dbd1e..68e0ee75ccb 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.mdx index 3c313b4afb5..4e5ef4b3199 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.mdx index f2944f69e21..8952d6b77a8 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.mdx index dffc58a8e88..412919a680d 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.mdx index 3424dba5bce..8681fba39b0 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.mdx index b9bb9d5aa99..fdf23171eaf 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.mdx index 55ae91c577b..95c98a4fed9 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.mdx index c647c006fef..d8de9ab7ab8 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f21a57c9603..509e4c7a572 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 228d354d16d..b249d1645c6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.mdx index 84a0c29e7b7..49f13d101cf 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.mdx index 31bb14e608a..159c8b45b11 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.mdx index 41a31e8b8fe..ad3d7baa0da 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.mdx index 52ba4d23cf8..8e24ef8fd5f 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.mdx b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.mdx index c37360eb77c..ee9faa63b85 100644 --- a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.mdx +++ b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError # qiskit.validation.jsonschema.SchemaValidationError - + Represents an error during JSON Schema validation. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.mdx index 78e42abd197..0190b8691f5 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.mdx index be478fc23ef..0fa502a9d79 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.mdx index 2d1e4fca4fc..a0f25da183f 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.mdx index 090758ed8db..39ada062624 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.mdx index ccfbaad8d57..44af67d38c5 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.33/logging.mdx b/docs/api/qiskit/0.33/logging.mdx index 4f136db8be5..8da2aa38179 100644 --- a/docs/api/qiskit/0.33/logging.mdx +++ b/docs/api/qiskit/0.33/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.33/pulse.mdx b/docs/api/qiskit/0.33/pulse.mdx index e16f8733c2e..6a00fd9f8c4 100644 --- a/docs/api/qiskit/0.33/pulse.mdx +++ b/docs/api/qiskit/0.33/pulse.mdx @@ -66,7 +66,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.mdx index e3f78be39a0..cebbef3c98c 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.mdx index 793299d6e8b..5d7beffc912 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.mdx index 8784601bd50..1b026f832d8 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.mdx index ead070aabb8..7c5aa2e1216 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.mdx index 841f7c8d438..8494d76a07b 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `object` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 7d052257825..d3458962238 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.mdx index a575f626610..7c2a38cd989 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.mdx index 0634af729e9..f397e69cac4 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.mdx index e218f90ebb9..a8302d4d325 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.mdx index c2844057d1b..c0ec57731ae 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 9554ca6535c..efd650f2750 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.Grover.mdx index 40992ab0cfd..c5063497cb0 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -131,7 +131,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.mdx index 56481ddf022..0fe37bbb831 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HHL.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.HHL.mdx index c96e226ded2..586b7a1c37b 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 5a841454695..f7c22245b19 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index fdfc4adb596..a0a184cedd1 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 3a9efe71687..8dff306dc59 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index b19a8cc054e..4fd142bea8c 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.mdx index 9f66788e8ee..dce41390dce 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.mdx index 9c49e792a25..1a997811449 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.mdx index 3c438e78500..3249ff8fb58 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index c34355d9e79..d1c66d5a68e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 6b2ecc58626..4d22f1f0176 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.mdx index ae52d40ca5d..5a81d74b4cf 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.mdx index c93b853d1b8..a18a1b5c5a6 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.mdx index 4206754e7e4..f388be86dfe 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.mdx index 17bdd6d6658..412ab4c3efb 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 393de1524ba..a0b60fa00f8 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.mdx index f2596f3d14d..9a61f606d4d 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.mdx index a311cd8cf9c..b58e3420dad 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.mdx index 38695ea0ad2..58ce9688d78 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.mdx index 1b7cd1dfec7..539aeaa2f3f 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -215,7 +215,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.Shor.mdx index aed6dd4da5e..bdaf133e884 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.mdx index a1ce2494661..840f4cb0058 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.VQE.mdx index 5b88a06c4b3..0f471345033 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -213,7 +213,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.mdx index f37e3d666c1..ade625d500d 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.mdx index 67a128ed47c..7556433bd6f 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.mdx index e03d8b898ee..57b54e623e9 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.mdx index a7bef174549..e67478f14c3 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.mdx index 8f99c0296b8..b2381f760ce 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.mdx index f8f3da4dc99..8b1dbd3f3a2 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.mdx index c1ae934498c..361841bee01 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 2b86c08fc65..3f7bbd17704 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.mdx index 991987f0fd8..13d9d78f25f 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.mdx index 515a79529a2..cf0b01a626c 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.mdx index dc928244a86..ee3c6ffdc44 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -138,7 +138,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.mdx index 6c5e6456f3d..0af54f49ec0 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.mdx index 54af5abf08d..458984d82f9 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.mdx index a8008fa798c..50da5e90786 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 764165497a9..a7881f200a7 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx index 23e2ed33077..49c15c5320d 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.mdx index ffa67f67f49..adb3757bd06 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.mdx index 734af1251ef..b2362144980 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 654f4553d74..512c6464e62 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.mdx index 5e56435f272..1f1d73b80a7 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.mdx index eb8805644c4..94bbd1848e8 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.mdx index 7227937ba24..19a2cc628bc 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -106,7 +106,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -116,7 +116,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -150,7 +150,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -240,7 +240,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.mdx index 7b3ed55f771..714a4864608 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.mdx index cca2e965006..0ce83bbec23 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.mdx index 7c59262c2f4..6433cb7c150 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -133,7 +133,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -149,7 +149,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -239,7 +239,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 896b8d37382..02371a130f3 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.mdx index f2fbb6130cd..9d25c0c178e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.mdx index 2c13c50f0e1..a61dddcb4ff 100644 --- a/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.mdx index 0274e70d01b..d6a4c95267b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.mdx index 41e637633b3..89c53a6af50 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.mdx index e2a06580b6e..434fb41ef1b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.mdx index 595bbd6f985..307540ffd68 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Clbit.mdx index 76c24832694..3e3c0553f51 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.mdx index caec2769453..7a4713bbc58 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.mdx index 42c3673a8ca..00aa9e2d60d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` Abstract class to encapsulate all control flow operations. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.mdx index 6de77f7e279..2665b9eddb8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Delay.mdx index 4e4c4a0f51a..17e3ee045dd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.mdx index 8d7da6b7186..8d341e63c3e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.mdx index 9f88cc70507..13bfec5e6bd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Gate.mdx index 63372c52835..d5bd36fb1cb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.mdx index 4f51d7a6b6a..967c29b2686 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Instruction.mdx index 7736cc83873..e1b446bd3f5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.mdx index 1bf56ea5880..88e1a4fe44b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Measure.mdx index 01f1e79027e..94758e4cd90 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Parameter.mdx index 727f7fd3239..581984e1b30 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.mdx index 28c361edea8..0a6839b0b80 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.mdx index 4e9cd924021..c3297db77c4 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.mdx index 0096f1c48d3..edcfbb78f73 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -347,7 +347,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1249,7 +1249,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1267,7 +1267,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.mdx index 70b39db2f7b..35b20cf85e2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Qubit.mdx index 01ca5cededb..0d30ac09cce 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.33/qiskit.circuit.Reset.mdx index 3296a71ed10..572cbff95ed 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.mdx index 55cbd220d70..0c6caa81a89 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.mdx index e6086addd0a..aa9ad04c698 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 08f40367f2f..8a1ae1f3b8e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index d7fdd672d4e..c09373102f6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 3e1cc0d6486..3635ceb2491 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.AND.mdx index 175d46fbf3f..dfd30c0cb16 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.mdx index a1f13d55996..d54a9a0d173 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.mdx index c0afcba14e6..303cd5469aa 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.mdx index fbc4e8a4811..9245b26bd3f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.mdx index bd0f80b792b..82e19bee559 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.mdx index 2e30f088945..fa56653e4d7 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index ff3def931ef..a272a0572fb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.mdx index 47388fbc721..d72c5fc1d83 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.mdx index 62f5b111a03..ab920e3e58f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.mdx index bc8f6567fa3..64c2e955fe4 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.mdx index 79138a95e5a..aa3aa505b71 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.mdx index 8b483f41df5..00cd097942d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.mdx index 8839c537218..e3e42500256 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.mdx index 07a7192afda..79032f52f03 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.mdx index 384b5252986..2214bed6e64 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.mdx index a84481f125b..406fa685e5f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.mdx index fd2b39e709a..90578198b63 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.mdx index 977c9b9c306..401648df8b2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.mdx index bfb9cfea618..a72fc9bc52b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.mdx index c569968c761..d0c11ac4fcb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.mdx index 9beae82da7d..a34fe4f62da 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.mdx index 2b10d1e7176..b00fb0a18ee 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.mdx index 692f0bc616f..dde1465ab82 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.mdx index 87fbfe6efe4..931b14f1203 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.mdx index 8914b85d562..b44ab700256 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 3779dbfb838..fc6bd2a09fe 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.mdx index 9829016cb77..a6773500c4a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Exact reciprocal diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.mdx index aa7c6ff2e1c..c8eafab9cfd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.mdx index 9267f76728e..a4171990841 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.mdx index 78d4a43c899..5d2c8b707f1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.mdx index d48eaf33c72..29cca607a58 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GR.mdx index af78ff35158..39d693613db 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.mdx index cc612dd9f3d..fb18508b381 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.mdx index 3e3b1abcc34..459208e9c24 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.mdx index 10317319cd8..861edd56fad 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.mdx index ed2b65d70c8..a82107b80c3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.mdx index 1400d145a19..676dd4267a9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.mdx index 3c09e0cfd2b..32e3c8d0dab 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index d566bde5de7..4cba75240d7 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.mdx index 1d3ce2c50e8..a399db71038 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.mdx index 9e1bd161008..c40ced79014 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.mdx index 512c46207eb..64b65686ed6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.mdx index 7f00604b87d..d97979f8559 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.mdx index 445a948d7a8..3fbafac54f6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.mdx index beca91e1874..14bc6d78dad 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.mdx index ccf2610f949..0cb126435f5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.mdx index e869bd4aab4..75406e18fe1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution # LogNormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.mdx index fbde0e2add9..e90c8af9a4f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.mdx index 3a85d2e770b..4e63e4c4697 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.mdx index ec34409b55a..386fe3ca3c9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.mdx index 75b8aab9dc2..939ab42af03 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.mdx index d63c26ecb6a..d6f6a9d3bba 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.mdx index c70123c9f91..ecaa45cdb5c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.mdx index a946ecb6266..dbee000f094 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.mdx index d3559c866e2..06ba931a6a5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.mdx index e602873adf2..25223dfaeb6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.mdx index 8346b6a67b1..96646bf285f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.mdx index ca3f0a14a0e..cd6809f9b31 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution # NormalDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.OR.mdx index e47d5eb4b59..7b6f1419dc3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.mdx index 434079c40e5..db8baac3f9b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: `qiskit.circuit.gate.Gate` Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.mdx index d486425db8b..54945ec875f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.mdx index ffd320d1588..2bc7b75ed5c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.mdx index 4c3632b1b3b..496934c1b9e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.mdx index 74978fae8b5..77b9469c9bb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.mdx index 0e6d7d40545..f7ec7baff85 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.mdx index 9253d7f651b..9aafbd5dc6b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.mdx index 8355bbc0d30..2bf7ffed9e8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.mdx index 597a32a8216..1446588e914 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index a882e274637..f840002c786 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 2c4b0dd14cc..f99eba748d0 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.mdx index 0c83ae7b117..229f0075b24 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.mdx index 637195349ba..77cbd098413 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.mdx index c76caae8277..9d70b6a4cad 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.mdx index c28fdf29d0f..ca10ef38f89 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.mdx index ac6b72c79f7..f1a2f3d99e9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.mdx index 12e46c1161e..0f23ec9e1f8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.mdx index dc216dc2050..7c965da1f66 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.mdx index 75d86fcb6a4..810002981f3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.mdx index 304cfc4f5bd..b710a5a9b71 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.mdx index 775884a5381..d5334bb63e4 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.mdx index b2160c2ffe9..d7fb69beb74 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.mdx index 5774ef47803..6b68386cab1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.mdx index 4d43e98a045..b6eeab6c071 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.mdx index 723a05bda95..c330ebd52d0 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.mdx index 579cf51f570..324d7c4165d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.mdx index 83cb846ec13..b1dc7145633 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.mdx index d2feba6ccf7..9cbef2c9d7b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.mdx index 3aff80c7ece..2ff8ec394fa 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.mdx index 0964106e70a..5ebadc7c805 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.mdx index b0336cd704f..d46f213009e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.mdx index 1213e2927e2..31c176cdbf3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.mdx index 7997335deec..b35dadcbae0 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.mdx index 860aa5087a1..b791666217a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.mdx index 168031f7327..1d3de66412d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.mdx index 435b769b41b..060b3da0fb3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.mdx index 84bf5bd1969..3636239eed1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.mdx index 8528b52c0ca..7d291fa4d16 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.mdx index 04036f750c7..cfc7971d88a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.mdx index fe99e5f2967..76afce0fe02 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.mdx index 39aa8b8409a..e9618ccbf17 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.mdx index d9bc17e43cf..5ab92574a50 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.mdx index 81a857d6c1f..545d4f40bcf 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution # UniformDistribution - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.mdx index 6aa1be7069e..eb3f03165b6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.mdx index 30adce11a9d..e51a5963b0f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.mdx index 78a52c81ab0..cd62a463e4e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.mdx index 4bc9c6c66e0..112aa162792 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.mdx index ac9ec2891c1..866b0d18bd4 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.mdx index 5f22962a61d..0391a63dd94 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.mdx index b8a1ad48827..fa1fbcd94f9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.mdx index d53dca8bc73..b1f95273608 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.mdx index 0c8fce9ff45..7a4e537ae95 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.mdx index f8cdd977874..049d5fbe8d1 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -248,7 +248,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.mdx index 5a4a940f925..15e41f7a733 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.mdx index 59fdd33d844..612d405724e 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.mdx index b2bba3f885a..119dbb6a37d 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.mdx index d29d71ab560..6e71a46a0cb 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.mdx index 245403326c0..06edd587b6d 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.mdx index b4d8da18334..058390dbfee 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.mdx index 6619537e5fb..548d2d8b64f 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.mdx index e6501804864..0dd9a08fd81 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.33/qiskit.extensions.Initialize.mdx index 8547b684dd1..51ed1a668ec 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.33/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.mdx index 98d2e4e4f81..18a75cc3735 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: `qiskit.circuit.gate.Gate` u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.mdx index bca516b81f5..efa186794c9 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.mdx index df9afb14336..ec1d6b6960e 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.mdx index 92aa0ae0abe..e99f086f5d6 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.mdx index b9d77fcf22d..4aa6f2b340e 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 82652e66f58..8804992d5f3 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.mdx index babab36fa7e..4482b8d9637 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 9dffa8bff43..bc8a9c12429 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.mdx index bc9432cc614..0824240c6be 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.mdx index 20fd6b614f4..fd52ff2d0a3 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.mdx index d9b264711df..150e971e208 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.mdx index 7d567c5bc3b..e8aed31585e 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.mdx index d63d4cf3030..17f9fa43e13 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.mdx index 2f435cd2a2c..688b355527b 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.mdx index 47a64918080..4da5b7c6cb7 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.mdx index 208fa733911..87f461262e0 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.mdx index 3da3a6e2737..0a10381412f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.mdx index 39e9f10be13..c819b99ef57 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.mdx index 26700712ffd..4652d14b971 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 44c959cae4e..43783fc8a20 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 418d1fa59a2..b4baf74199e 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index 932574b4613..2dde1f820cb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index bc8483eca85..c6901aad408 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 4dcd2800ba3..33c6bb81fa5 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 4dfc095b0fe..730e0b80c9a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 9dcb94b827d..a4f9fca1427 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 6eaff8df214..db6374cd075 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.mdx index 0c1b904bb7a..5f4696179c8 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index ae5e01d4ad7..a7f98e960da 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.mdx index 268a1e17b8c..a093c4a6180 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 384ac48825d..af0fb218d06 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.mdx index 9bc1e589e2d..d03132df395 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.mdx index 6364f8cea72..ec898bfe14f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.mdx index 38cfe2ebc49..b44e6407e53 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 44e365b69df..bf9fbaaecbf 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.mdx index 20f8f282950..b2002c9eecf 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.mdx index b0887c134cd..645f577be60 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.mdx index e53f83fb41c..311271a2f1a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.mdx index 49209882f79..6a750eb6501 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 07e9a590794..639353483e2 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.mdx index e94eb302846..3d214e98ff5 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.mdx index 4b82f35fb56..4b967d7affb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.mdx index 85419233c1a..a43166538fc 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.mdx index 046bb83bc71..466767137d4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.mdx index afa75bff6be..4e3a642f9f4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.mdx index 1d38d8670ef..c28f7b27efe 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.mdx index 1731b6d111e..e0a358ef667 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.mdx index 406557d0f7e..6a24257f010 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.mdx index 27cf4f46730..a7c31ff373b 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.mdx index a323b4f1f45..5c55de9f618 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.mdx index 599edf01a72..dfbf785870f 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.mdx index de7ea2ba01c..855687d63dd 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.mdx index 958e516ea32..0b35c4067b2 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.mdx index 8138130476c..6b5784f91e3 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.mdx index 84a3cab20a3..9c9e9bb8db4 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.mdx index 186d4eec06c..a1fe7ef6cf6 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.mdx index fe3964f9ef7..0f7002c2481 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.mdx index b5b2757a981..2fa069db9e9 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index acf28927761..2e179bd1dc7 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.mdx index 5045297a76e..92d025918ac 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.mdx index 598c4cd1a9d..aa7b7db6c00 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.mdx index 9eba4a1f78b..0556ec47b83 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.mdx index 7e7c2d0a9f5..2c8110c439a 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.mdx index ae7e41c94bf..f5372a63b96 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.mdx index 695e3a0106c..53283925546 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.mdx index aecdcfef718..7a8e7819848 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.mdx index 8424e74c494..23de891285c 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.mdx index 8b00852793f..c454301f54c 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.mdx index 0e6d8b519dd..c3fc187b205 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.mdx index cb91f203190..f89759deb94 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.mdx index 63c9434a339..af5e4d3bfd3 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.mdx index c93d7013138..d90f72b89d4 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.mdx index b51c100508d..5cf419abd0d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.mdx index e8e7d073cf8..8cc71b0c814 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.mdx index 03a4c1f7ea4..3e04880b9f4 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.mdx index c5e290ca56c..9f5e393a33d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.mdx index 9f2531b2522..52d9a31216d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.mdx index bcdd4491662..35043fbb542 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.mdx index b87a2c85f8f..80589d27464 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.mdx index 3b1300fc78e..edaabed332d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.mdx index 971a84937c5..8c76de342e0 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.mdx index 830abcc8cfd..1df64168451 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.mdx index 08df7f76c64..3fdd24fa383 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.mdx index 3da6ce76e33..49fc3d3ce5d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.mdx index a14a9e58729..6bab508fc0b 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.mdx index 9851a27b411..404a059062a 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.mdx index b1836298300..052de2192ee 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.mdx index a253d6389ab..3e4bbe8ce67 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backend by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 39fcbfea27c..c0e3b728e03 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index dc4c0374fd9..d328a928dc0 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 6dafbc02137..0c3c2d0fe8a 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -56,7 +56,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 64ae78230fa..cb131213f91 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.mdx index 16dc5a91d85..56650e45130 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.mdx index 2515cad9bb1..ee8f5b1e306 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.mdx index 998bb935149..3b392f851b9 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 2a1262386cf..6e238cd464c 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.mdx index 531338533fc..ebb40746ddb 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.mdx index 7205f8b0158..407a18ce3e1 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.33/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.33/qiskit.providers.Backend.mdx index bc26d9a45fa..8ec572869ee 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.mdx index 6e27bb86b0c..f3ed238990e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.33/qiskit.providers.BackendV1.mdx index f4992e4559a..b2f079f5aae 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.33/qiskit.providers.BackendV2.mdx index cdfd734689d..e610741dcaa 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -144,7 +144,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.mdx index 19e4333bcb3..c3e89dd8c94 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.BaseJob.mdx index 6aeab13cc68..8a68be90823 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.mdx index 5d8e29e35ea..bff035b2441 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.Job.mdx b/docs/api/qiskit/0.33/qiskit.providers.Job.mdx index 60ea05457ce..684120e799f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.33/qiskit.providers.JobError.mdx index 9e50dc45490..52786b8e5fb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.33/qiskit.providers.JobStatus.mdx index eef57599170..4b0d1547328 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.mdx index e4574a9f32a..1bb6f1ecc5c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.33/qiskit.providers.JobV1.mdx index a49bff78f6a..1c0224080c8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.33/qiskit.providers.Options.mdx b/docs/api/qiskit/0.33/qiskit.providers.Options.mdx index 5710ece8156..85c627e8fd6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.33/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.33/qiskit.providers.Provider.mdx index cc7c81bb46e..6903507ce65 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.mdx index d240e51ccab..08a774c6749 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.mdx index 6ca5a5b1d4b..bed7096ef06 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.mdx index 1837568756e..9750bad8696 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.mdx index f5d45324e73..f86276b2b55 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.mdx index b0f97a7b4b5..9b6b15cd19d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.mdx index 1ac5ba580ec..36e5147d082 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -203,7 +203,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.mdx index 39b6b410f58..3bb0292b6c2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.mdx index 4c70ed73f8b..2ab073beb25 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.mdx index e1deda88448..d79a5cbc884 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.mdx index af36737f947..4de66c199e2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.mdx index 554176c7602..23a6011849a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -96,7 +96,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index d1d2663e5d8..8c98b8ea2ee 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index 543d365d9ef..1bf854872a7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index e2ba63752b8..c10dc50fce6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index b2eabfba507..aafff40ea35 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 48f186464e6..84d034288ac 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.mdx index e8d0f031bd3..447011556f7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.mdx index 0b968f7c1d0..35fface0455 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.mdx index 89410e78a9a..c29592fdef2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 8e0775f17b8..8676af28886 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 9f1aa41586c..bd3fe6f3117 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.mdx index 74861cb3253..116e1b1d4ef 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 6ff7faba689..ee916dcd31e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.mdx index 810df0416aa..c4a6c430087 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.mdx index bafcaf138ed..13f842cd39c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index 2cc9d8acc41..6fb59619f25 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.mdx index a9847da7007..42a013770cc 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.mdx index 70f73981412..71a372ee9da 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.mdx index faef1778a42..5f1bfb7826f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.mdx index a198f5be680..ac7c6b9f456 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.mdx index d2d5a7e356d..84fda52d8b9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.mdx index f4a2fabfa36..46a6f1f5ea8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.mdx index 11c6275f94c..8f8f46fa0b6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.mdx index cfb4e94f54d..c5b59d3f033 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.mdx index ce5a3b0ec7d..66ba3da5e74 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.mdx index b9972774226..d0d714f8226 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.mdx index 7ff1b19955f..06e1d600d36 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.mdx index ba733286a64..b74cec68bc1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.mdx index f42e7bf27b0..dac95973dcd 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.mdx index a5c7ee1c806..a0219f8d41b 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `object` Quantum error class for Qiskit Aer noise model @@ -180,13 +180,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.mdx index d8f483dbd02..6ab625de8c6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -153,13 +153,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.mdx index 5d1fec56e1e..b6ec7e26958 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.mdx index 077844871bd..7fcfa708655 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.mdx index 88058d62519..d6eda4bffbd 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.mdx index 81808a703b1..dc46767018e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.mdx index 6f86fb8beca..4e4d6551128 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 0a32649b033..3e4f3759091 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index ba448b9d74d..df79eb07be1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index c3ad593bd8f..bcd033a257a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.mdx index 4a670091b51..1052c25fc68 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.mdx index f900db51eb4..53c31365501 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 8d918aa62b3..5c728ef20cb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index a453510f0f2..a35140282d8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 3e26eddd42e..e125fa9e9df 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 2cf7ed39d47..3d5bff03d99 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.mdx index 82d9ac47109..92658ea4564 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index a8e422d14f2..000f3bd4cf5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.mdx index c8d8ee5618f..544d0d63f61 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 43dc150ff74..ec43b2905dc 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index b2d564519e6..8d75a71b7f3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.mdx index 6df2d95f50f..ec2291dc46b 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.mdx index 4f172af2bfe..2ea1738fa28 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.mdx index abbffce7184..bb307049ee2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.mdx index d6b5f5c6fce..56a59ac03e4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.mdx index 8ad154d44f2..4c320b46cbe 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.mdx index 56c6ab05c41..dc22e0d02e6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.mdx index ed11ff8dd24..0065028662f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.mdx index bf480c87e1f..c66be14c3ee 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 30a76743686..621f3494055 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 78bb642951f..ecf75b7d0e9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 576fc29424a..6b8ca6fb117 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 4113c397932..b83c50b7de7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index c2d848ad6e5..869549f328f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 20898a3fa32..ee4d19b90fb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 940a11d4564..0d1d5ef2025 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 46f5a935655..467044de149 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.mdx index 2aa40b203a4..cc4c36557e2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.mdx index 617697ad076..ce626d8b90c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index c4f1c74269b..1cc29caf820 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.mdx index c877ffd03aa..da537c0a4f7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 98ea0a611ce..cc4e01adc56 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 1dcbce8fe12..fd998735e0d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index e7bcd366c4b..544fb71e613 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.mdx index 549739042fc..8044e89b37f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 9c576b62ded..31b54d952ec 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 96e28ed15f0..1661f69998a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 43bd6a25f6f..4821615a3d5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index e03108b13c1..d515af277fc 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 4a341dea061..4b7c98d62f4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 313e10a4be3..274bc021428 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 085f7b1ca71..f50a6843609 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.mdx index b78917c3e65..9899f580860 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 703df2cab0b..ac41145d0b3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.mdx index e557169ed2a..1a1d70a0960 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.mdx index ef234f4b144..dc618f937e9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index acdcf85aa26..9206ccd16ea 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.mdx index caec51020ea..ed6783d51e1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 495164f87b1..4e1e77e8628 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 7525c0e9002..8398f392b63 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index 11078eeea8a..63b1b5a8d09 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 09f8f25b785..4833d689406 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index bf022d29afe..a1a5ba50da3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index b955744d1b8..4958435d203 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 383cec5ebfe..a71186b0f4a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 57e890bfbcd..9edfed69aca 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.mdx index a4a704f06ee..6c1801aa2b7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.mdx index 840aca45043..804e9661ada 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.mdx index fd89acfb499..ba5c85f6ae8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.mdx index 48d4b753f07..c90a7aff18c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.Command.mdx index 9a30b76dc6b..a0abc22f222 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.mdx index f03b35d7f4d..98a58fd4b38 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.mdx index 58bac3ba4da..133012a46e9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.mdx index 6063a3c9fe1..7deed9073c5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.mdx index 36e5b32280c..34a6051195c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.mdx index 228d6e22fdf..345f21ec822 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.mdx index 30439d45d85..d4864ee14c9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.mdx index 2ae508867a4..5ec8ce15966 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.33/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.33/qiskit.pulse.Schedule.mdx index ca7a26afdc9..15d55162500 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.mdx index 7570f598c38..fdc0704c246 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `alignment_context`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.mdx index efa6e3db434..551d41cfe08 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.mdx index 0fb0e92a525..fb4de89fe38 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.mdx index 9750ab1461a..8a1414dee11 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.mdx index d883e8f815a..9683cca2ef5 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.mdx index 73aecde1745..2d00cfecd4e 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.mdx index 1fa1f141dbe..591cdd5308d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.mdx index a458edf789f..645ec195fc4 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.mdx index b0486f31ec5..0045e7193e5 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.mdx index 868b92e09f6..a2108c00d6b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.mdx index 621586d1b40..cca9091bfd2 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.mdx index a3598134968..be815b9ab5f 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.mdx index 3319fc63cdd..7d75b431834 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.mdx index 2a20c54bb34..896ee9978df 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.mdx index 47371ed2b8b..29819c822b9 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.mdx index ee7ea10dc11..de8729c796d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.mdx index ce4d63fa4f3..40d6ffceff9 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.mdx index 5d2739cf46c..3156b5b5038 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.mdx index 7648967a327..56443bc2118 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.mdx index 4d2bba0a3ab..c8557894e32 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.mdx index 4d5dbb59bab..8aa0e35bd0d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.mdx index 45007da8999..5777e1cdb9b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.mdx index 60a97f4e06e..3a7aa0cb389 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.mdx index 344d4eb0ce4..3b3fd52e15b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.mdx index ea0e2538022..f2e38f3ba09 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.mdx index 65b62c559e6..fc66f426250 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.mdx index 83ba02cc8ec..b30dadf6110 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions sequentially. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.mdx index 52f5ac03b4e..d67fd240c49 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.33/qiskit.qasm.Qasm.mdx index a6b5cee7ea4..4767454df2c 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.33/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.33/qiskit.qasm.QasmError.mdx index a256cfcd369..2625302bfd7 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.mdx index 97996073fad..791a0e567fe 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.mdx index 1f256938b9d..0564d6f5feb 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.mdx index 31f96e31f15..5525bc81950 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.mdx index d6a648a4616..35760a51acf 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.mdx index 8ca831fd089..e18f23d4e8b 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.mdx index bb2a7c8d81f..3a1819ed772 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.mdx index 37777df8979..5b5bbf1713d 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.mdx index cb722ae57fc..5e973be8a0f 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.mdx index 0fa4c8292f1..e30432d2b9b 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.mdx index ec2483e2690..fc05c773b6d 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.mdx index 31421f2c0c8..42cd66b6801 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.mdx index 897155b6b65..b0470a2f79f 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.mdx index 3c09213101d..0c5b1e666a3 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.mdx index 2743510e259..82aaa31832d 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.mdx index ab87a2c6f25..7754a90c946 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.33/qiskit.qobj.Qobj.mdx index 8a9025f81a9..d30430adef5 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.mdx index e44e12144f6..7c4f16657ba 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.mdx index d20b5aa74ae..645b195ec87 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.mdx index 52b1bf11c67..e840c9087fd 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.mdx index 1cc7ecba628..9587eb9135f 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.mdx index 2dac77a9bd6..c1db55fc3a2 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.mdx index a5e620a7cb0..3a4fb741504 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.mdx index c9b77cb4316..ec0a7e92301 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.mdx index c1782d21b92..9c1fb42afa0 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.mdx index ab557ef5a8f..4971ec0b09d 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 27bc0cab4e9..4568f9e90ba 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.mdx index 60ce4b5f5cf..fbae6324d8e 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.mdx index 7de6edecf34..655ec386511 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.mdx index 1228cf3432d..f158a4960ce 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -335,7 +335,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -455,7 +455,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -497,7 +497,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -542,7 +542,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -556,7 +556,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.mdx index dd15af2982f..21b472a0b02 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -363,7 +363,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.mdx index 93a06ab2d9b..2b4d64c2316 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.mdx index ee3670271eb..b150c13b893 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.mdx index 106276a335a..b99d07151af 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.mdx index a8624b38732..c22931080a7 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -132,13 +132,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list \[(pauli\_str, coeffs)] ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -296,7 +296,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.mdx index fe9951e6c6a..654b1d63a49 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.mdx index 8379c15da82..174f5f99cb1 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.mdx index 6d80e137452..6a6e0389780 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.mdx index cd8eb0c4c01..7df12e7389e 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.mdx index 77f97e112e0..ad876259c54 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 416e43dec8f..84c1df190e4 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.mdx index 195f5be50a3..18847b04c1a 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.mdx index 423a071dd3b..803b5764d01 100644 --- a/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.mdx index 717a5dffe7b..72e45adb7da 100644 --- a/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.33/qiskit.result.Counts.mdx b/docs/api/qiskit/0.33/qiskit.result.Counts.mdx index 730d8e2bc8a..8756ff20026 100644 --- a/docs/api/qiskit/0.33/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.mdx index 8d0a5824854..a25293cc3eb 100644 --- a/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.mdx index d9b93148102..bf189a8be01 100644 --- a/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.mdx index 58b5b65f9a1..28bcdd2c95d 100644 --- a/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.33/qiskit.result.Result.mdx b/docs/api/qiskit/0.33/qiskit.result.Result.mdx index 79e0a174dab..ce1399f3a84 100644 --- a/docs/api/qiskit/0.33/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.33/qiskit.result.ResultError.mdx index a44d3713fce..15972791a37 100644 --- a/docs/api/qiskit/0.33/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.33/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.mdx index 643561cde3d..13c7c2ac34b 100644 --- a/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.mdx index a82b430a233..394f48d418d 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.mdx index 736640ef506..a55c47a3b37 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.mdx index 041fd76b125..7acca47ed4a 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.mdx index 858fc4e45d5..6849c9f681b 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.mdx index 5bb08dd569c..f30d749e21f 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.mdx index 89d95ac3a57..73e459e3c1e 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.mdx index 6c9020b27bc..f4ff76fec45 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.mdx index 9626230e753..c1e0933d789 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.mdx index 1674794a401..6e57f0a53d9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.mdx index 438f1550eb5..ed65a210f98 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.mdx index e35dcf9c4c4..4aab2b563c2 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.mdx index 2df09818eb3..c91b83fff29 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.Layout.mdx index 9cde2e736a3..f1a548c2dc5 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.mdx index 96034e205c3..aab11a4f9b4 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.mdx index ae77603afb5..297f5e1d0a1 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.mdx index 3d93caaec9d..519a9b4bc56 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.Target.mdx index 0b0fdc3c9ef..ba85bbc4e84 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.mdx index 80cba8d7e60..a4b1009f254 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.mdx index efb310cf426..85b9a609cbd 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.mdx index 9021cd277ed..01b5da64a03 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.mdx index ac2d6e52c76..171c05765a9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.mdx index a271d5a8f41..b78bac25f14 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.mdx index f72b2eecda4..b9b758b330a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.mdx index fe8c9c34881..e4ef8debb46 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.mdx index cf738719a59..988f968d27c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 61dc61649cc..9c1f69f8823 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.mdx index c17e7972916..d12bed52171 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.mdx index 6cf455a0799..311d67579ae 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.mdx index 0492dfb5dc2..03c02e8e250 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.mdx index 54e76fa5118..080b0bef082 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.mdx index f54bf8e641d..c95098537de 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.mdx index 25cf8452df9..29e30680d11 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.mdx index 7bd2758887e..4b01e44f73f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.mdx index 174022bd7b0..0032e723228 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.mdx index 4a433447123..25df1210f79 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.mdx index f137ed783f2..ec2ce3896d5 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 30b9d8d7893..40bac1b0541 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.mdx index 44a0decd331..ddcf272551d 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.mdx index 51eadff5cfe..f5737538895 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.mdx index de2edb2e043..ff1d675d844 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.mdx index 5aae3af91d1..3f6c3b18467 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.mdx index 39abada0485..c488deb1a57 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 8d4ee53316f..236f1109ec9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 5f2fd07958c..ee898f4c427 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.mdx index 177544e380b..a02627531db 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.mdx index 0a47e45f4d1..2f9f30be96c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.mdx index c39b3ed3e02..72737f31196 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.mdx index 2ca7937d9de..53d63208e8c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.mdx index 1898867bcba..713e445e0a0 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 0b35f272ca2..e1fadb57415 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 14c20475f73..a36297f8e64 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 9b24e38c9e3..893f7dd0d8a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.mdx index c3146992ecc..6b55dacbf38 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 1cfd9270dec..3c3fdff8a0c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.mdx index 3dd184ea112..7213136c5bc 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.mdx index 69570425841..4a44d19a869 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.mdx index 076b0f4e080..ef9dc5ce5ea 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.mdx index 81b5a853a91..336c656a674 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.mdx index 33c7526e4c8..bde0395376c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 03b68c50f5e..ebb9cfafa34 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 98209b6f2e5..127ea05850e 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.mdx index 47355176df9..696b0275b04 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.mdx index 437a390bfa0..c42a0b023bd 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 2bee32f9ce2..3e780b7e1ae 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 205f6c25f5e..b9de8cfcf83 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.mdx index f3b32da47ba..0fbfa7ceaa7 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 7a28fc60fab..9026c0e5ece 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index e071dede1f8..e0c05faa661 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.mdx index f8682ab318d..29d16366b9b 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 2bce71304be..e5a118b9f31 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 078203099eb..b59f9fc1d56 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index dc960c57f51..1299067a781 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.mdx index 2b96cee9c61..6dbc6ba5403 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.mdx index b952974886b..f65c010759e 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.mdx index 9ad70f5afdd..990432141c9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.mdx index ac09fec9b9b..f35a6bbcaab 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.mdx index 0f1107227f1..c76f5b8525e 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.mdx index de5d871446b..ca6545c0650 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.mdx index 8a6a7445302..c07606ea885 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.mdx index 77d28dabdd5..cddb0777312 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.mdx index 498a2e797a8..4e8ecc1b9f3 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 26eca097305..007aa6d684c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 953b93d0cfc..ffd97a3f538 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.mdx index 34ceacd6f8e..85c4e5295df 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.mdx index d187c7924f5..63d3aef7b30 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.mdx index 7cf86efe05e..7da32e45617 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.mdx index 8b9f4bbe96f..bf1125ca371 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index d2a9067faeb..2afe5d7b496 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index f12af110254..297ee46d6be 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.mdx index 4924017b889..9a8d7a97873 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 51e2d69af79..ce688812674 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index ad47bef5e49..08bace8ffd1 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 85bbec216a5..e0ee727b0b3 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 658087fce4d..301282c0379 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 8247d590daa..a5318f6a27c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index 167bf7bdbd5..154e05684fc 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.mdx index 95c65536618..e3f68608978 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.mdx index a60a0f85455..b232c056dcf 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.mdx index d3518288231..9ae7336b88a 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.mdx index e45e8f58d82..423b1673a48 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 7596f822b74..cb272c88a3e 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.mdx index fb83a89eafb..823b98117c9 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.mdx index 09acd59e109..11c1fef4ab5 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.mdx index d540e2831c5..a14621cedb8 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.35/logging.mdx b/docs/api/qiskit/0.35/logging.mdx index 4f136db8be5..8da2aa38179 100644 --- a/docs/api/qiskit/0.35/logging.mdx +++ b/docs/api/qiskit/0.35/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.35/pulse.mdx b/docs/api/qiskit/0.35/pulse.mdx index df71f32d939..91500438977 100644 --- a/docs/api/qiskit/0.35/pulse.mdx +++ b/docs/api/qiskit/0.35/pulse.mdx @@ -66,7 +66,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.mdx index 177ecbbc08b..c7dd4d09e23 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.mdx index 4470c379e44..9550942a7c9 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.mdx index 281fc8b49d5..a5857979018 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.mdx index 8dffd70a0e7..004cfe94d7c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.mdx index d46b92d6535..3c45be0db13 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.mdx index 397b806e206..0dd12d9be13 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 7f236188892..56f1df0a882 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.mdx index e5db70c5cc3..419873627a5 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.mdx index b7d8777c29c..567f8b4a8bc 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.mdx index 67d5f7a34ef..4a852b99e7d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.mdx index d0e6cea1dc4..4d9568534b8 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 4f6bd4bba69..4762a127bdf 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.Grover.mdx index f6b2561d947..bce782bcd6e 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -131,7 +131,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.mdx index 5926ea6424e..bf3bce46b14 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index a7480784bd0..6de691136d1 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index d6841d7d43d..97f4a7c6eae 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index b9806de8d5c..291b1c89f51 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 2f399794b41..6fed2413916 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.mdx index fa21486b3a7..de564dca142 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 15eefa2e787..16785e04748 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index e0c39b9f973..477fe5ae8a6 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.mdx index 9c06c1c9210..d3b954ee466 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.mdx index 997cdee8b9d..18f8c102a88 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.mdx index c0d8d8b3c16..db43762afeb 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 95414e2344e..8ad3492d5d6 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.mdx index edfe97a1421..0be7366cb37 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.mdx index 748dc9e4bd9..4998f26cf89 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.mdx index fb13a6a9f7c..f2e25562433 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.mdx index 4380c5aa4a2..83d99b00d42 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.Shor.mdx index 3d21724ab8e..04c334e264a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.mdx index 22cbe168757..977388ff689 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.VQE.mdx index 354dcd9c8a0..8dca8d20157 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index d9fe75ae408..2f524741dc3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` An observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.mdx index 2871d0c68b2..f6309fd28d7 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.mdx index a9981c87d6e..25144c517a5 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 5f2e8eb4210..799e910c723 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index ea057ddd32d..35076e260a9 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for linear system matrices. @@ -249,7 +249,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -449,7 +449,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1029,7 +1029,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1171,7 +1171,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1189,7 +1189,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1990,7 +1990,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index a282df390d1..276965a6fcc 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` An abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index aec6345536b..648e3de2420 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` A class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index 5cdd12f77bf..5f901ff7000 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index fea699d5f46..1d1d3dacc94 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` Class of matrices given as a numpy array. @@ -272,7 +272,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -346,7 +346,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1194,7 +1194,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1212,7 +1212,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index d580536d482..4203853b89f 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` Class of tridiagonal Toeplitz symmetric matrices. @@ -285,7 +285,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -359,7 +359,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -369,7 +369,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1207,7 +1207,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1225,7 +1225,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.mdx index 751c1b80f98..7d017a299c0 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.mdx index df35572af73..9b737ac48da 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.mdx index 9d474948878..7d21c788681 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.mdx index 9ed2d72b7a3..898302b149c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.mdx index d4c51a2651e..994733d9acb 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.mdx index ef031fc6bba..e61c6a26a8a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.mdx index f083f058e71..8452ffe5917 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 7f4baffa5ec..44b61fd1d07 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.mdx index 31ed6566a0e..e4c014502ee 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.mdx index ede04e77b19..cf873b1cdfc 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.mdx index 31ff30a34ec..c21c8d12802 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -138,7 +138,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.mdx index 14d5c377818..6f5cc596027 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.mdx index 229aa459ebe..96cd99a7f28 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 50b8c31375b..e7b0c1dfca4 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 9dd8fc5cae4..001f0b682c5 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx index 5eb03b6219b..733bf5f2d0a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.mdx index 0e15dfbc676..288bea0bedf 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.mdx index 11a7a52b3bc..28aa29dbc4b 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 1d64e412039..3ba8cabd5ed 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.mdx index 2e1d1759707..968c2393c68 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.mdx index 8923761f8ed..c5b6466dabd 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.mdx index 1d7f3e29b43..e1c5dcbf36e 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -106,7 +106,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -116,7 +116,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -150,7 +150,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -240,7 +240,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.mdx index 3d4afb41f93..14869235c63 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.mdx index 29c1577f75d..37ac7695d18 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.mdx index 437c3345b74..36c8458f39c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -133,7 +133,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -149,7 +149,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -239,7 +239,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 603ab09c5f6..2c50815f5d3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.mdx index 7c323f9201f..c9454cff56a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.mdx index 7ef0fa3a307..0ee388ededb 100644 --- a/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.mdx index 3b4086ba4ab..9eccb9ec90d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.mdx index a7152c2875f..1ed8f3c0c25 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Barrier.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Barrier.mdx index 52c8ad772fc..7bfa7c4a9ba 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Barrier.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.mdx index 7ffd97e2639..15cec3a49ce 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.mdx index 8db3a52c9e2..a6fbfa27596 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Clbit.mdx index 0750c8f3ed0..6bb6837da31 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.mdx index 15b15d1d6bf..c799777f224 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.mdx index 6dfdb7feafa..efc573d3b3c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` Abstract class to encapsulate all control flow operations. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.mdx index 534fdb88517..ae18b84c59e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Delay.mdx index f0f40cfdb8d..4e2ba4fbae3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.mdx index 4c46cb8cd0b..c2f16114d62 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.mdx index afcf3cb868d..0f1c968f5d2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Gate.mdx index 136ef136ead..e728f66a434 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.mdx index 8a2ee339845..45fe1e518b7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Instruction.mdx index f0d4f907195..1ee10d66f93 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.mdx index 56d5df1cfc5..d51a62098cd 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Measure.mdx index 96f560a505a..43625b4961a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Parameter.mdx index e28c176a617..da33b2b8654 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.mdx index 64578d0435d..f4f0e738127 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.mdx index 3e3ccbb5755..c0cd98745ce 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.mdx index 3ade0546ac7..13c6b71959e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -347,7 +347,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1249,7 +1249,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1267,7 +1267,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.mdx index e555f3d89cf..7875948ed7a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Qubit.mdx index 8954c0dca7e..0188f8184cf 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.35/qiskit.circuit.Reset.mdx index f790bd8f332..a5a24cd9c44 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.mdx index db2245aa63e..1829cbdbf96 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.mdx index b3ad11b75ed..204f3b568a5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 0b40fe0147f..96946c48480 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4d7fb059d90..c6b801921e3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 3f06dab8649..16718ca326a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.AND.mdx index 52541144a90..7b2f1b94048 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.mdx index 8908e16de43..fd52303f41b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.mdx index f332093efd0..057609c3832 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.mdx index c243ef9cbf7..4cf1e16c8e3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.mdx index 99c7ab342a6..d2aeb6ec8f0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 983a13a9080..26b086c3755 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.mdx index 46db00f2ffe..0481013776c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.mdx index 5463856f1cc..80f7a937389 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.mdx index 5c94dd2aadc..58e592447a7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.mdx index 69460299478..39e05434042 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.mdx index a9b2731b034..2859f107722 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.mdx index 6618ad19402..6aa75f49bee 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.mdx index e83d32e901f..f6fa4d7c6cb 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.mdx index 2c0db0d3637..69fd8c80f65 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.mdx index ca397ff19fb..598a3ac2513 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.mdx index 05acb5a7b37..726fa592a14 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.mdx index cd50da2a388..14aafbad86a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.mdx index de07cae2013..a4a60e39b00 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.mdx index ab9f3558d28..f2302004838 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.mdx index 1474b7ee7c4..aeb9beb0748 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.mdx index 1fdbc2fd505..5fb9057ef7b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.mdx index f64a59aad6f..4103fa62e31 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.mdx index ac5490c7a03..e52f69562ae 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.mdx index 6f6cf918c19..8c09a781086 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 8dc4d8bc0a8..b9f2e53c9b5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.mdx index d5ab50a1eff..9eb7ad2089f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Exact reciprocal diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.mdx index ef426999738..1748e92f3ed 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.mdx index d006dc68aba..73c36839242 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.mdx index f6596072285..c827575c8be 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.mdx index 7fe5619c057..d410c87a94e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GR.mdx index 11ec39ef8ca..a31f54e690f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.mdx index 23d3a8397a5..c4f553cd2c8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.mdx index 7d883def64c..49efd645ebf 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.mdx index 3a2540f1027..759cd2bd2d6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.mdx index 0ba4735848d..77ff506a3e0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.mdx index b87ec683f5c..60ebd152dce 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.mdx index 04b7bc1c58f..aca23906efa 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 3fcac9f69f3..8a17a281669 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.mdx index 65ef72d9f92..430a22398d6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.mdx index c0d49deb6ff..81e873a2fa3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.mdx index 798c57b2c1b..404bb031ee4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.mdx index fb922858333..6cfaa506693 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.mdx index 16d56b33e43..254038ce22c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 071a1d50945..f8cb914f474 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.mdx index 54fc7028bc5..d4da5eb8089 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: `qiskit.circuit.gate.Gate` A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.mdx index 8bf86de6dd3..5bba4079404 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.mdx index 35b231430ef..a5991db00e8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.mdx index 7db60499cdf..ea222a14388 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.mdx index 31240598e2e..7aad438433d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.mdx index 7f348bfc368..9542bb70892 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.mdx index 553acec6ffa..2a8d47f3a62 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.mdx index f78a3048c47..eff5a13b7b0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.mdx index bcae47380d2..ba17033d455 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.mdx index 1cdac17461a..57f510468b1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.mdx index 73ed86e204d..5b4a9b846f9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.OR.mdx index 685635241fd..c956a10b2c3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.mdx index 50e399d02cf..ed8961ecf76 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: `qiskit.circuit.gate.Gate` Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.mdx index 82e6921c3e1..6af5f644eda 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.mdx index e725c1c5fbc..1e50c140f07 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.mdx index 6c998f0c7f9..13e415fcdd9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.mdx index cfce07408cd..ed23863094b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.mdx index 3ab754c55eb..6bc52638a61 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.mdx index 93351dd1561..ff4bcce7ae5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.mdx index 090c61efefe..a7f36f5c23f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.mdx index 2ecd33b6ebd..c9a994ae772 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index c33489913d4..fc707701938 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index dd876b9e202..e3bf31514d7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.mdx index 66f7949ffbe..e9dd05e1cf8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.mdx index 9adb91f5aae..813e0e985ee 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.mdx index 1ffcf972f00..7759f2baf1a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.mdx index fc106f4fcfc..13d60bf119b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.mdx index 959900546fa..e02b605baa7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.mdx index aa9b8d82c9a..5c95fd80f9e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.mdx index d4049bdd4ac..6a023dfd69e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.mdx index 3ed823070ea..a9fe6d33d31 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.mdx index 0b0bc55f398..555f31b4e0e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.mdx index 964dec835e2..221abfeebf6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.mdx index b45ecda895b..d2d92158724 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.mdx index 191982e5547..62b3daf8232 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.mdx index 6cb1d1bd699..58f8f80cc15 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.mdx index 46ece93fe53..789f6b49831 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.mdx index 5e8cf91cdc1..2cb10edf005 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.mdx index daa52dfe5b8..c59560fc18b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.mdx index 23dbf3e8f81..bbd8831faef 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.mdx index 0c0845cb4a5..fbee714740c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.mdx index 2c0b7df9101..473a7c7590f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.mdx index da08424dcbb..e8ba1e2b72e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.mdx index 80bce05177c..9dfa573d3b5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.mdx index de124f75857..95793287ddb 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.mdx index c2a1ba169ac..162a6a6f0a1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: `qiskit.circuit.gate.Gate` Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.mdx index 8e917fd1f1b..619a1a6db95 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.mdx index 0392d5be348..8440447c269 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.mdx index bb29c819410..c630e992a4e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.mdx index 5311fb227cd..d7691675c1e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.mdx index b87cc62da9c..b04c783f1e9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.mdx index 970e09cafe6..7b42602a2f2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.mdx index 146213b2738..7db380f0a18 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.mdx index a9c1d41bcd9..18bb4c245d6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.mdx index 09492e8f316..c29ada980fe 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.mdx index b43079c40b3..1516e453b50 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.mdx index f311438cc14..df40d5548d3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.mdx index dfad8844a2c..3985d8a9fee 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.mdx index edb09ad6564..0dfdb7f96de 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: `qiskit.circuit.gate.Gate` XX-YY interaction gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.mdx index 5ddda2d2478..1aab9855196 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: `qiskit.circuit.gate.Gate` XX+YY interaction gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.mdx index 9cf87fd273b..c21fe942c0d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.mdx index ab3f71b121f..80c9d024cae 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.mdx index 4273b314786..ef030c5b547 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.mdx index 024c33d024a..399e565a1f3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.mdx index 61b9606389c..9b1b1b0725e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.mdx index 553f6b494d3..5b00d4a655b 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -269,7 +269,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.mdx index 250839a1657..cafce2279b4 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.mdx index 93056beb28f..3a2991cb0eb 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.mdx index 7c1525cb1d7..9de9b230eab 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.mdx index bddc7f68128..97162fd6b75 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.mdx index 720b381c2ac..89b6566153a 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.mdx index 92fdfeddc0b..35593ad4ed4 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.mdx index edd8abd6bc1..b6145af058d 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.mdx index 992669bc5d9..fc7d564ed49 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.35/qiskit.extensions.Initialize.mdx index 0400cbade38..4d448e1c5d0 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.35/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.mdx index 50155c5f394..aadf0f9597e 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: `qiskit.circuit.gate.Gate` u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.mdx index 3ffe6f31149..7847bd3c052 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.mdx index 866ce93c958..2f88fe4b695 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.mdx index 92aa0ae0abe..e99f086f5d6 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.mdx index b9d77fcf22d..4aa6f2b340e 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 82652e66f58..8804992d5f3 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.mdx index babab36fa7e..4482b8d9637 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 9dffa8bff43..bc8a9c12429 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.mdx index bc9432cc614..0824240c6be 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.mdx index 20fd6b614f4..fd52ff2d0a3 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.mdx index d9b264711df..150e971e208 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.mdx index 7d567c5bc3b..e8aed31585e 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.mdx index d63d4cf3030..17f9fa43e13 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.mdx index 2f435cd2a2c..688b355527b 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.mdx index 47a64918080..4da5b7c6cb7 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.mdx index 208fa733911..87f461262e0 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.mdx index 829ec37514a..5ca1208f33d 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.mdx index 39e9f10be13..c819b99ef57 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.mdx index 26700712ffd..4652d14b971 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 44c959cae4e..43783fc8a20 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 418d1fa59a2..b4baf74199e 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index 932574b4613..2dde1f820cb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index bc8483eca85..c6901aad408 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 4dcd2800ba3..33c6bb81fa5 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 4dfc095b0fe..730e0b80c9a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 9dcb94b827d..a4f9fca1427 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 6eaff8df214..db6374cd075 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.mdx index 0c1b904bb7a..5f4696179c8 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index ae5e01d4ad7..a7f98e960da 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.mdx index 268a1e17b8c..a093c4a6180 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 384ac48825d..af0fb218d06 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.mdx index 9bc1e589e2d..d03132df395 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.mdx index 6364f8cea72..ec898bfe14f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.mdx index 38cfe2ebc49..b44e6407e53 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 44e365b69df..bf9fbaaecbf 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.mdx index 20f8f282950..b2002c9eecf 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.mdx index b0887c134cd..645f577be60 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.mdx index e53f83fb41c..311271a2f1a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.mdx index 49209882f79..6a750eb6501 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 07e9a590794..639353483e2 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.mdx index e94eb302846..3d214e98ff5 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.mdx index 4b82f35fb56..4b967d7affb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.mdx index 85419233c1a..a43166538fc 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.mdx index 046bb83bc71..466767137d4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.mdx index afa75bff6be..4e3a642f9f4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.mdx index 1d38d8670ef..c28f7b27efe 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.mdx index f6285665e44..926585fef6e 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.mdx index c0916b95fd1..5ac6e7523db 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.mdx index 113b99e316c..5478557885f 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.mdx index d4ffbc3a817..14c32ad501a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.mdx index 2e7171592df..e9c131dc799 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.mdx index c55be67fc11..04e9dd76c17 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.mdx index 2a7fbe23620..f55142b7c7b 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.mdx index cfb18206d91..bc84eefb5fa 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.mdx index e4b12a2a7f0..d92d07806b1 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.mdx index ecb920de336..e32c74844b6 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.mdx index e63b95d250f..4520831ac40 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.mdx index 43fe77c2c48..97f7da4f697 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 87274e6c87d..fbdb2aa06dd 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.mdx index 80d952eeb8b..1489637786a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.mdx index 7aae20792ec..453f91462f7 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.mdx index a494c478246..ce028762ed9 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.mdx index 29dff3a4a73..ac7e08f6e76 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.mdx index a39fdb41f05..b8b3a4c66a4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.mdx index 9679ed31e04..2ee8255c3f3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.mdx index 20f653c7571..21d3ac48bd3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.mdx index 3b35d786503..e083da4b09e 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.mdx index c85e05761a0..8f81c6b245f 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.mdx index 9aa3f93e4fb..72669c15f3a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.mdx index d6da06e06a1..b34c7cacf0a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.mdx index 3a13db39e10..5a165d26ecf 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.mdx index d638eae1d13..8956c1fa824 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.mdx index cb94abb0698..c5bcb451654 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.mdx index abee321dc01..3ecd17305fc 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.mdx index b8d1aff8b78..3986d72b2b4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.mdx index e5abcf57885..0d05cea34b4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.mdx index 8e50dbdc653..a526e880cd9 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.mdx index 6e31cc09b80..e8d49fbc7fc 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.mdx index 2193dc59871..ac563c0b473 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.mdx index d6f1e80d774..2f0551f88db 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.mdx index 85c503502de..8d74933cae3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.mdx index 4bde58f93fa..48dde121a32 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.mdx index 7f1afebe779..adb31cfda15 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.mdx index 120f6f5fbd7..dcf475a29c9 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.mdx index 2157c17a710..abd6254b94a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.mdx index cbab981be2c..e40561248d1 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.mdx index cfae9d790c6..5ac63037fc2 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 1333beff8b1..3a3b9fb5d21 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index d2e1fb2ef3d..0c7d6c5f348 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 9632b0113ae..163caf032bf 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 0b8b9c28e69..dcd17767eba 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 0830d5ab474..df12540c885 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.mdx index bccbec9fe25..3a18cf32d2b 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.mdx index 3f29cdd2fc1..46b3c3a0052 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.mdx index cf8da0e8d79..3276d29d9cf 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 46f5b07d67f..d0f5110fccf 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.mdx index d4449150d5d..9ec07f2f6b6 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.mdx index b4cb3c1a635..4aa11d232af 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.mdx index e578d28688e..b576c580221 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `abc.ABC` Estimator base class. @@ -32,7 +32,7 @@ python_api_name: qiskit.primitives.BaseEstimator ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.mdx index 6efd915b194..08698352242 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `abc.ABC` Sampler base class @@ -28,7 +28,7 @@ python_api_name: qiskit.primitives.BaseSampler ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.35/qiskit.primitives.Estimator.mdx index b5af3e381b1..e6b0bcfe368 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: `qiskit.primitives.base_estimator.BaseEstimator` Estimator class diff --git a/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.mdx index bf62c287ea5..e8056f6de18 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `object` Result of Estimator diff --git a/docs/api/qiskit/0.35/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.35/qiskit.primitives.Sampler.mdx index cd36c8e6a05..d43d2db329b 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: `qiskit.primitives.base_sampler.BaseSampler` Sampler class diff --git a/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.mdx index 8caf112037a..dd6d8eeb4da 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `object` Result of Sampler diff --git a/docs/api/qiskit/0.35/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.35/qiskit.providers.Backend.mdx index 203718d68ec..b9104e22865 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.mdx index dd94ea5666b..a8fc0c9eb27 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.35/qiskit.providers.BackendV1.mdx index cb6002397fc..f5589e2e7ec 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.35/qiskit.providers.BackendV2.mdx index 09d6fe9d97d..39e5534c8f4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -148,7 +148,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.mdx index ba3a8bb9c63..20c79cd0df2 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.BaseJob.mdx index a3236948211..6133bccb9a9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.mdx index 218af8d7e2b..a9a4dd983c2 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.Job.mdx b/docs/api/qiskit/0.35/qiskit.providers.Job.mdx index c0723e6a5ac..20ad90b45dd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.35/qiskit.providers.JobError.mdx index bda1efc2bcd..120479ad216 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.35/qiskit.providers.JobStatus.mdx index ffdab4ea30c..f066ddcde2c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.mdx index 7f255f661ea..64e4b81d629 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.35/qiskit.providers.JobV1.mdx index 93ad8047945..b0092b422b5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.35/qiskit.providers.Options.mdx b/docs/api/qiskit/0.35/qiskit.providers.Options.mdx index 9a2a51c0089..a6ad3d26e60 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.35/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.35/qiskit.providers.Provider.mdx index 2eb4bfd7ed2..9dd824fa4b7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.mdx index 6f83db0f7f5..cb4c9a75b74 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.mdx index 912032a9ee8..56605a57312 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.mdx index d66ffb5cbb6..3a4ec2104a4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.mdx index b4aecfd0aaa..efb82483790 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.mdx index 6ff282b7b69..1199b839fc9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.mdx index f363c0fe620..a00d39cc07e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.mdx index b6aedd18a7c..c2563e6715c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.mdx index 98d63a8278f..c0c32538a9f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.mdx index 3b31ce7ddc0..391e567364e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.mdx index a6368f4fce9..edd7c7f6db0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.mdx index ea1937c6690..fada3a5f926 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -96,7 +96,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index c305ddb6231..0384bd4d71c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index 7f0cc538b3a..2faa1d0dc29 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 3d24cd5e0b6..43bb3344e4e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 5411d219e72..914ae33d642 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 6fea0af08bf..bd728d77345 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.mdx index 8b7f902dbab..9082e168bcc 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.mdx index ef1026a89d0..7bbc66a4cea 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.mdx index 6837cd77a5b..ac67cc9eb6e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 2c9a9ad11ee..45678a8cbb6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.mdx index 843dfead86c..f79e427a7e7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford # SaveClifford - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 7b9faccaa48..6e832717e08 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.mdx index 3f3c4b6e12f..011d1cecb09 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 1ae419d3a15..7ac5ba69953 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.mdx index fedf2fe3509..883b99599bd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.mdx index 6aa89f185cd..f56e0489327 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index cb1f47ef778..b3b6d5f5fdf 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.mdx index 9b94e06b228..44999fa713f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.mdx index 4d619585a07..651e3c08310 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.mdx index 3f925c44191..c4d4bce4ea3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 55ee531eb06..0dc2977189a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.mdx index 1fdc362386a..898891749d9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.mdx index d77642c3706..fc85f3fed38 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.mdx index 239a65335c9..e512fd39ecf 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.mdx index a724a87f28a..bbef4271e57 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.mdx index 76b48579e0c..b43c8f7a7ce 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.mdx index 0e0ab042014..ae144a88ec1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.mdx index 97dcfb4a37a..ac8b4b6c149 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.mdx index af9feb59a12..4f5e09d2409 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.mdx index 97af26fcf8a..cfe7949d3d7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass # LocalNoisePass - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.mdx index e5e3390e56d..cf823eee0c7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.mdx index db307d6cfaf..393379c2e8e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -221,13 +221,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.mdx index 6a2f2f6f5df..afebd359507 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.mdx index 5f8535a159f..7998f7516ca 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: `qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass` Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.mdx index b43821740f7..74ad7242f39 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.mdx index ac87d005db2..7c370cba755 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.mdx index 732d31f4dbe..fc5c1d1dcc7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.mdx index 0d683abb029..377b186cdd8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.mdx index a1352c6a6ef..1416541f040 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.mdx index c9eaed57e3a..147b499bfb3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 2092fa2c3f7..8783de09b15 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 7d8b91ba098..244190f31f0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.mdx index 4a670091b51..1052c25fc68 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.mdx index f900db51eb4..53c31365501 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 8d918aa62b3..5c728ef20cb 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index a453510f0f2..a35140282d8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 3e26eddd42e..e125fa9e9df 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 2cf7ed39d47..3d5bff03d99 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.mdx index 82d9ac47109..92658ea4564 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index a8e422d14f2..000f3bd4cf5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.mdx index c8d8ee5618f..544d0d63f61 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 43dc150ff74..ec43b2905dc 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index b2d564519e6..8d75a71b7f3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.mdx index 6df2d95f50f..ec2291dc46b 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.mdx index 4f172af2bfe..2ea1738fa28 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.mdx index abbffce7184..bb307049ee2 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.mdx index d6b5f5c6fce..56a59ac03e4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.mdx index 8ad154d44f2..4c320b46cbe 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.mdx index 56c6ab05c41..dc22e0d02e6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.mdx index ed11ff8dd24..0065028662f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.mdx index bf480c87e1f..c66be14c3ee 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 30a76743686..621f3494055 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 78bb642951f..ecf75b7d0e9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 576fc29424a..6b8ca6fb117 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 4113c397932..b83c50b7de7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index c2d848ad6e5..869549f328f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 20898a3fa32..ee4d19b90fb 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 940a11d4564..0d1d5ef2025 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 46f5a935655..467044de149 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.mdx index 2aa40b203a4..cc4c36557e2 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.mdx index 617697ad076..ce626d8b90c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index c4f1c74269b..1cc29caf820 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.mdx index c877ffd03aa..da537c0a4f7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 98ea0a611ce..cc4e01adc56 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 1dcbce8fe12..fd998735e0d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index e7bcd366c4b..544fb71e613 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.mdx index 549739042fc..8044e89b37f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index 9c576b62ded..31b54d952ec 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 96e28ed15f0..1661f69998a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 43bd6a25f6f..4821615a3d5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index e03108b13c1..d515af277fc 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 4a341dea061..4b7c98d62f4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 313e10a4be3..274bc021428 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 085f7b1ca71..f50a6843609 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.mdx index b78917c3e65..9899f580860 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 703df2cab0b..ac41145d0b3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.mdx index e557169ed2a..1a1d70a0960 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.mdx index ef234f4b144..dc618f937e9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor # CQCExtractor - + Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.mdx index acdcf85aa26..9206ccd16ea 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob # CQCExtractorJob - + Bases: `object` Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.mdx index caec51020ea..ed6783d51e1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService # IBMQRandomService - + Bases: `object` Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 495164f87b1..4e1e77e8628 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 7525c0e9002..8398f392b63 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index 11078eeea8a..63b1b5a8d09 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 09f8f25b785..4833d689406 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index bf022d29afe..a1a5ba50da3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index b955744d1b8..4958435d203 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 383cec5ebfe..a71186b0f4a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 57e890bfbcd..9edfed69aca 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.mdx index a4a704f06ee..6c1801aa2b7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.mdx index 1db1e21762d..494c08b9ebf 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.mdx index cf7f435996d..18745049615 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.mdx index 990ab4d8585..88ce9fae43e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.Command.mdx index 86a6e36d89d..b0c6ff20566 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.mdx index 4555e839a65..b91bce468f1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.mdx index 5509866e6bf..84b024099ad 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.mdx index df2b869c772..5e9e7c22dbe 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.mdx index 170182f6974..ab2af388c49 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.mdx index e08f510e096..c33ac5c402b 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.mdx index 2cefbabbfe7..4dc056e13c0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.mdx index 82b7916f7c2..f1678648b9b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.35/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.35/qiskit.pulse.Schedule.mdx index 366d240917f..dc28ad618f0 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.mdx index 6d2e6b5bfd7..1b8728be1ad 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `alignment_context`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.mdx index 26bd3e526a3..4ac670adb3e 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.mdx index 19ed18d4edc..a8a1ddb7596 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.mdx index 5daaea04618..f76d2afe3cd 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.mdx index 40e7be7e551..88fb9fa2da9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.mdx index 7ac432a9ad5..25c25075797 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.mdx index 2b79dc879f3..65c5cafdc53 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.mdx index 352d533bce6..2f1dea34adc 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.mdx index 87d03c5e4b7..747de4c36fb 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.mdx index cdd2eca726b..58197c07921 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.mdx index b9dce2e9a45..819098b8a6c 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.mdx index 7a993e5ad88..feaa8d29020 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.mdx index 58fe05e9a6d..d16ef593953 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.mdx index e9625c894da..5455acddbcf 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.mdx index fa32727712b..1bfd024f5e9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.mdx index ff472c580ed..1eebe796847 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.mdx index 73596fd7588..52152f7eb11 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.mdx index f9e9336cbda..d1bc7648eb9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.mdx index efdfc075093..dcf03e7840d 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.mdx index 2b6286bb417..1867f0271c6 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.mdx index fb7e33fea45..85686a11871 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.mdx index d765e01f7b4..5d3a37a9eb8 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.mdx index 435efdec536..60153de449e 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.mdx index e4e91b60be5..1e9eb2934cb 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.mdx index 64debdb8c61..116c52c59fc 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.mdx index 27f7797c740..3b48b76e5b5 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.mdx index c39359798a9..b96deea6d52 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions sequentially. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.mdx index c5f6ef78e77..7667352070f 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.35/qiskit.qasm.Qasm.mdx index 54130fe72ec..c706fafe4c5 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.35/qiskit.qasm.QasmError.mdx index 78303b9dda2..d67ce3063b9 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.mdx index 3c7374cec01..4fc904b243d 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.mdx index 9bb416d307b..c4314d4ddbd 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.mdx b/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.mdx index 63df520c933..124a5c40660 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.mdx +++ b/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm3.Exporter # Exporter - + Bases: `object` QASM3 expoter main class. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.mdx index 78e05f5b08d..bf90562c426 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.mdx index 8f107e797a1..165228792c4 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.mdx index acb97a97e24..f03af86a838 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.mdx index 2854cf19f66..be426d91b4f 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.mdx index 4840c768d6a..2fee3386fce 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.mdx index 0e12582c59a..62286846c45 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.mdx index 2f360276a1d..6e3e92f80c4 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.mdx index c8f88b3d8e2..c5df92463d3 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.mdx index 4f8b66b3f9b..e4c8d7b7200 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.mdx index 839e374c013..2c1bc4a96a0 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.mdx index 671c052242d..03469ebcd2f 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.mdx index 1a2cddf1981..c7d56f75b0a 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.mdx index 9abc9257017..1dc83966145 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.35/qiskit.qobj.Qobj.mdx index 9f2e3258813..e1ec6c1e3de 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.mdx index d01685f8be9..153ac72852f 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.mdx index e93ede4f247..387c371137c 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.mdx index 1a8bd43b86d..a9e3791f88c 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.mdx index 960a2218900..c5672dcdfee 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.mdx index 3a4c1fc8bb5..58e958d2b9e 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.mdx index caba42b377d..363214238b5 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.mdx index a93989afeed..99c1ba74809 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.mdx index 625cfcefd67..1b929614cb2 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.mdx index 709b979c7bd..1daf7efe54a 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 71bd9fd7dbb..4b24642b478 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.mdx index d0ca8553410..4a980f8d514 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_circuit - + Create a new Operator object from a :class\`.QuantumCircuit\` While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -176,7 +176,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.mdx index b786204ffb0..44819341f7e 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.mdx index ee1e7ebf6dc..11f7dc30245 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -338,7 +338,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -458,7 +458,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -500,7 +500,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -545,7 +545,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -559,7 +559,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.mdx index f6f5ca3d13e..a34d0cd0d4f 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.mdx index e65737742c2..1afe5b98aa3 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.mdx index f9791b375e7..1f382fd2fe3 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.mdx index 1cb78ee8943..01478bc05e8 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.mdx index 5789638bb6c..269f27f72e0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -172,7 +172,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -207,7 +207,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -233,7 +233,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -407,7 +407,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.mdx index 49d8adf9ade..c869e2c74cd 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.mdx index 9ea8cd4e40d..d1603833f8a 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.mdx index 140b89ef4ad..7cee62a391d 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.mdx index 3b28b3fb532..78af9dd68c1 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.mdx index d806d7e6325..b346dbb43f4 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 5c07824f23e..6ab6dd4c0e8 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.mdx index cb6b7bf9f6e..02c4fd2dff3 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.mdx index b4bb1e2db7f..d6ac062fdd9 100644 --- a/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.mdx index 81747e9fc9a..6ea36213d32 100644 --- a/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.35/qiskit.result.Counts.mdx b/docs/api/qiskit/0.35/qiskit.result.Counts.mdx index efe402d9b77..97ece81eb59 100644 --- a/docs/api/qiskit/0.35/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.mdx index 85b12edfbf8..46a6f7e8cca 100644 --- a/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.mdx index 738ae26b686..d3d1f27af79 100644 --- a/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.mdx index 12bae05ba76..eb0bf6a21ec 100644 --- a/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.35/qiskit.result.Result.mdx b/docs/api/qiskit/0.35/qiskit.result.Result.mdx index 102ec04b453..128caa427e6 100644 --- a/docs/api/qiskit/0.35/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.35/qiskit.result.ResultError.mdx index b334d8fc6c9..e49d074d3c9 100644 --- a/docs/api/qiskit/0.35/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.35/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.mdx index 6c2469d12a7..fe276b9be3d 100644 --- a/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.mdx index 259e763cb7d..7654af97806 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.mdx index 9367247601f..d29ab7ec4eb 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.mdx index 6630063bd03..64cfac9e59a 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.mdx index 41fe8adb370..ac528eac137 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.mdx index 47035687155..e986e9d2f2b 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.mdx index 98323a8dcdb..e1cdc28a99e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.mdx index dd22d653346..6bfb9eb6c29 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: `qiskit.transpiler.runningpassmanager.FlowController` Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.mdx index c3e04196dd7..24343e96d4a 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.mdx index 06e05c2845a..dfc5e77e9bb 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: `qiskit.transpiler.runningpassmanager.FlowController` Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.mdx index 2d2027f0e49..f5726eb002d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.mdx index 4b5df9c3654..b99f4b15c5e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.mdx index ee3ec0ae095..344bf46efd2 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.mdx index 45f9fe7b65a..e1d3b4f7b82 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.mdx index 451034e4f71..3391059f457 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.Layout.mdx index d572e890332..3af697c6fa5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.mdx index 1f97087b50a..34c3dec3175 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.mdx index b979a17b19b..2aae0de8877 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.mdx index e0d91c4b5dd..bef72a4d905 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.Target.mdx index 9c94abf1f2b..7c972c8a7d4 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.mdx index e00f098ef45..4047f4d0ed4 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.mdx index fb90f60bb4b..a43d242ffc5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.mdx index 496c39663f6..71ff4e76fe7 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.mdx index 6d4c9b3a339..e2f6788c0cd 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 036755cd1b7..ed35dc12f91 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.mdx index 6be07de8a6b..1f267369348 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index bbfa808b078..9f75b7c9d74 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.mdx index 3e2db00ea0a..8bcec25892d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.mdx index 274410d707c..05b15880ad5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.mdx index 407a8e0c676..443b7bd8aab 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 382629b90df..c7658ffee3e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.mdx index 662b3636174..2d96779abf8 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.mdx index a046a8a6b53..a334a061d02 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.mdx index c8ed6f773b1..50ac110d894 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.mdx index 34fc7abe5f3..8153495775d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.mdx index df785f5c36d..b286924368b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.mdx index ff601e326d4..e912d1a0473 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.mdx index 06348a11c48..1e8d81eb786 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.mdx index ac4328f3d3e..3b891010fb9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.mdx index f6109f57f7d..87dca89c701 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.mdx index 03efc3b4503..bd413668691 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 3f17bae9e54..64858e69000 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 945b1012394..c49960d8372 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.mdx index 1b6fcffb0e2..a8d63e910ac 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.mdx index 444f14aac1e..00b9e0adc48 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 5a81883f825..091e35175f8 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 789775fabad..217c082f6a3 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.mdx index 6fd5e64cc49..e8d12614b9f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.mdx index c188c4f6249..c98db5338b1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 10274cf3d93..2c1492a6d37 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 51f6bdb6b5d..a0d68f5c7c8 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.mdx index 3898f776922..bd4a6dc76ef 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.mdx index bb0cf279e51..76daed840c5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.mdx index 3f9b912c132..f4550bf217b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.mdx index 86f100a4693..fa3cfd5cda9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.mdx index 0304bb65688..b2972efc98d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 530f081040e..e0284315542 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 10fbfa8e1ab..dc749a5fff7 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 19a891c923b..3f6c3a323d5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.mdx index 3dafead0f36..d4d2b2f0941 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 0aba195e478..152ec95eb1c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.mdx index 60a8270ab19..c52a50a66b1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.mdx index e2689559158..572a9af034e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.mdx index a7ce0b5cc0c..58f04bb2200 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: `qiskit.transpiler.basepasses.TransformationPass` This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 0657f12382c..2ed3cfadcd7 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.mdx index 0f1afbd14df..2f1493ef805 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.mdx index d0776f6c1d9..89d7ff5158d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 79409e385d5..f50566964df 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize linear functions. Under the hood, this runs cnot\_synth which implements the Patel–Markov–Hayes algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index b8d4cb7c73c..6e931804a56 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.mdx index 9b3d5f5f330..9822f2b4e15 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index cf08fb072b0..7bcbbdb1fa5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 9f69da16988..629afcf20bb 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.mdx index 6686a218763..35441518d7d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.mdx index cb3b3679160..89eb760b5dc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index ea1891f474d..a0d36d5fafa 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 35210c8712f..7866f671f30 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.mdx index 2b4a097394e..129e9db13df 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 1f6c69b406c..c196f45ec51 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.mdx index dfec0488e39..32932ce1fef 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index d0a3fd6eb99..0ac577faaf8 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 788a87272e2..a1130bdaea4 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.mdx index 6da85fbd773..4940bfdc785 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index aef8252aec1..8ff5a71af45 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 03e45472818..bbbc1a2e53a 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index b551bc111bc..e2560626256 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.mdx index b72c7b4cd06..0aa746a3c72 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.mdx index d3f9552bbb0..c836b3f0420 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.mdx index 3348a569d2e..009c0983403 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.mdx index 2b31e4a37a7..6ab2a332c00 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.mdx index 56ff3b59f16..cd3fdf27dc6 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.mdx index 664cd18a021..b80e122d945 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.mdx index 77ea6db4e26..717d64b8041 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.mdx index 9ee656572ee..f0be61ac77a 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.mdx index 9156a5d8230..02acb6874ce 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.mdx index 1142c426f02..2b83417671e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.mdx index aaa29f7a0ff..b740cc48a30 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 7618e6d7235..51b3d434a09 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.mdx index 4b16a6ab87e..7228652f556 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.mdx index e5f9300a7bb..5e6fe4c9bab 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.mdx index 22448b8991c..1099d704226 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.mdx index c1c981f065e..fe1b29ab386 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 3002e973639..ed4fab9dec1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 71c6c4a44c8..7aa0b1d5ba5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.mdx index b400b7ca384..d6694d72575 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index fb37e08af24..824e4deadc7 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 9bb9c2416b9..84f5031f78c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 1e46a533efc..77b8f2d0c73 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 0980a6519cf..267d44ff0d9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index e645182e1b8..8c16d017594 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index 135e328021f..1d8ffc58027 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.mdx index 4a468aa4621..f30bf4c71df 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.mdx index d6f96ee3496..1a5dfcc27dd 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 50c9dcc0863..b45a39f221e 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.mdx index 4672646fa15..fb1a0a76b30 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 03480323590..0bf7b342d42 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.mdx index 57cadf92efb..f831cc0b7a0 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.mdx index 13c825f4af3..327c3b43c30 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.mdx index 7eb862f0f22..2d065c717bb 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.35/utils.mdx b/docs/api/qiskit/0.35/utils.mdx index 40ab693439a..e8e401f9938 100644 --- a/docs/api/qiskit/0.35/utils.mdx +++ b/docs/api/qiskit/0.35/utils.mdx @@ -107,7 +107,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -147,7 +147,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -214,7 +214,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -228,7 +228,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.36/logging.mdx b/docs/api/qiskit/0.36/logging.mdx index 4f136db8be5..8da2aa38179 100644 --- a/docs/api/qiskit/0.36/logging.mdx +++ b/docs/api/qiskit/0.36/logging.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging ### IgnisLogger - + A logger class for Ignis IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. diff --git a/docs/api/qiskit/0.36/pulse.mdx b/docs/api/qiskit/0.36/pulse.mdx index 6be4035bb43..992e1b103f1 100644 --- a/docs/api/qiskit/0.36/pulse.mdx +++ b/docs/api/qiskit/0.36/pulse.mdx @@ -66,7 +66,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.mdx index 177ecbbc08b..c7dd4d09e23 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.mdx index 4470c379e44..9550942a7c9 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.mdx index 281fc8b49d5..a5857979018 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.mdx index a2230ec3cdb..d15b0997271 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.mdx index d46b92d6535..3c45be0db13 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.mdx index 397b806e206..0dd12d9be13 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 7f236188892..56f1df0a882 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.mdx index e5db70c5cc3..419873627a5 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.mdx index b7d8777c29c..567f8b4a8bc 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.mdx index 67d5f7a34ef..4a852b99e7d 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 249af2412d0..c954ef6ddbc 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 4f6bd4bba69..4762a127bdf 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.Grover.mdx index 110778f29ae..d7db7abaeba 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` Grover’s Search algorithm. @@ -131,7 +131,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.mdx index 5926ea6424e..bf3bce46b14 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index a7480784bd0..6de691136d1 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index d6841d7d43d..97f4a7c6eae 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 0858b3ebaa7..27d4144dff9 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 2f399794b41..6fed2413916 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.mdx index 8b4d189d2f7..173955fbbd6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index d6c4e991855..13411d4f779 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index e0c39b9f973..477fe5ae8a6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.mdx index 9c06c1c9210..d3b954ee466 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.mdx index 997cdee8b9d..18f8c102a88 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.mdx index c0d8d8b3c16..db43762afeb 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 95414e2344e..8ad3492d5d6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.mdx index e6fabf65d79..ccd3a78001a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.mdx index 748dc9e4bd9..4998f26cf89 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.mdx index fb13a6a9f7c..f2e25562433 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.mdx index 34947335dd1..3d160e179d9 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` The Quantum Approximate Optimization Algorithm. @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.Shor.mdx index 2e1ab40166d..34e4ea55c1b 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.mdx index 22cbe168757..977388ff689 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.VQE.mdx index 38cb8c740d7..82bae7ebc28 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` The Variational Quantum Eigensolver algorithm. @@ -147,7 +147,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index d9fe75ae408..2f524741dc3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` An observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.mdx index 848e7b182ed..8031a112aa8 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.mdx index a9981c87d6e..25144c517a5 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 5f2e8eb4210..799e910c723 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index a1a98a5ad9f..fe5602d6743 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for linear system matrices. @@ -249,7 +249,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -323,7 +323,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -449,7 +449,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1029,7 +1029,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1171,7 +1171,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1189,7 +1189,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1990,7 +1990,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index a282df390d1..276965a6fcc 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` An abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index aec6345536b..648e3de2420 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` A class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index 5cdd12f77bf..5f901ff7000 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index da8916fd40c..08e8eccac3c 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` Class of matrices given as a numpy array. @@ -272,7 +272,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -346,7 +346,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -356,7 +356,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1194,7 +1194,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1212,7 +1212,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 109e7fb2253..d8e4f901bb4 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` Class of tridiagonal Toeplitz symmetric matrices. @@ -285,7 +285,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -359,7 +359,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -369,7 +369,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1207,7 +1207,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1225,7 +1225,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.mdx index 751c1b80f98..7d017a299c0 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.mdx index df35572af73..9b737ac48da 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.mdx index 9d474948878..7d21c788681 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.mdx index 9ed2d72b7a3..898302b149c 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.mdx index d4c51a2651e..994733d9acb 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.mdx index ef031fc6bba..e61c6a26a8a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.mdx index f083f058e71..8452ffe5917 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 7f4baffa5ec..44b61fd1d07 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.mdx index 31ed6566a0e..e4c014502ee 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.mdx index ede04e77b19..cf873b1cdfc 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.mdx index 31ff30a34ec..c21c8d12802 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` The gradient descent minimization routine. @@ -48,7 +48,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -138,7 +138,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.mdx index 14d5c377818..6f5cc596027 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.mdx index 229aa459ebe..96cd99a7f28 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 50b8c31375b..e7b0c1dfca4 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -134,7 +134,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 9dd8fc5cae4..001f0b682c5 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx index 5eb03b6219b..733bf5f2d0a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.mdx index 0e15dfbc676..288bea0bedf 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.mdx index 11a7a52b3bc..28aa29dbc4b 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 1d64e412039..3ba8cabd5ed 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.mdx index 2e1d1759707..968c2393c68 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.mdx index 8923761f8ed..c5b6466dabd 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Parallelized Limited-memory BFGS optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.mdx index 1d7f3e29b43..e1c5dcbf36e 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: `qiskit.algorithms.optimizers.spsa.SPSA` The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -106,7 +106,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -116,7 +116,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -150,7 +150,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -240,7 +240,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.mdx index 3d4afb41f93..14869235c63 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.mdx index 29c1577f75d..37ac7695d18 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.mdx index 437c3345b74..36c8458f39c 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -99,7 +99,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -133,7 +133,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -149,7 +149,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -239,7 +239,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 603ab09c5f6..2c50815f5d3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.mdx index 7c323f9201f..c9454cff56a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.mdx index 7ef0fa3a307..0ee388ededb 100644 --- a/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.mdx index 3b4086ba4ab..9eccb9ec90d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: `qiskit.circuit.quantumregister.Qubit` A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.mdx index a7152c2875f..1ed8f3c0c25 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: `qiskit.circuit.quantumregister.QuantumRegister` Implement an ancilla register. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Barrier.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Barrier.mdx index 52c8ad772fc..7bfa7c4a9ba 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Barrier.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Barrier # Barrier - + Bases: `qiskit.circuit.instruction.Instruction` Barrier instruction. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.mdx index 7ffd97e2639..15cec3a49ce 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.mdx index 8db3a52c9e2..a6fbfa27596 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Clbit.mdx index 0750c8f3ed0..6bb6837da31 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.mdx index 15b15d1d6bf..c799777f224 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: `qiskit.circuit.instruction.Instruction` A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.mdx index 6dfdb7feafa..efc573d3b3c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` Abstract class to encapsulate all control flow operations. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.mdx index 534fdb88517..ae18b84c59e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: `qiskit.circuit.gate.Gate` Controlled unitary gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Delay.mdx index f0f40cfdb8d..4e2ba4fbae3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: `qiskit.circuit.instruction.Instruction` Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.mdx index 4c46cb8cd0b..c2f16114d62 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.mdx index afcf3cb868d..0f1c968f5d2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Gate.mdx index 136ef136ead..e728f66a434 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: `qiskit.circuit.instruction.Instruction` Unitary gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.mdx index 8a2ee339845..45fe1e518b7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Instruction.mdx index f0d4f907195..1ee10d66f93 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.mdx index 56d5df1cfc5..d51a62098cd 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Measure.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Measure.mdx index 96f560a505a..43625b4961a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Measure.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Measure # Measure - + Bases: `qiskit.circuit.instruction.Instruction` Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Parameter.mdx index e28c176a617..da33b2b8654 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: `qiskit.circuit.parameterexpression.ParameterExpression` Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.mdx index 64578d0435d..f4f0e738127 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.mdx index 3e3ccbb5755..c0cd98745ce 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.mdx index d6ffe73ed16..4f8ec51d71f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -347,7 +347,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -431,7 +431,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1249,7 +1249,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1267,7 +1267,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.mdx index e555f3d89cf..7875948ed7a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Qubit.mdx index 8954c0dca7e..0188f8184cf 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Reset.mdx b/docs/api/qiskit/0.36/qiskit.circuit.Reset.mdx index f790bd8f332..a5a24cd9c44 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Reset.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Reset # Reset - + Bases: `qiskit.circuit.instruction.Instruction` Qubit reset. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.mdx index db2245aa63e..1829cbdbf96 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.mdx index b3ad11b75ed..204f3b568a5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 0b40fe0147f..96946c48480 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4d7fb059d90..c6b801921e3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 3f06dab8649..16718ca326a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.AND.mdx index 52541144a90..7b2f1b94048 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.mdx index 8908e16de43..fd52303f41b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.mdx index f332093efd0..057609c3832 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.mdx index c243ef9cbf7..4cf1e16c8e3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.mdx index 99c7ab342a6..d2aeb6ec8f0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 983a13a9080..26b086c3755 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.mdx index 46db00f2ffe..0481013776c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.mdx index 5463856f1cc..80f7a937389 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Phase gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.mdx index 5c94dd2aadc..58e592447a7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RX gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.mdx index 69460299478..39e05434042 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RY gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.mdx index a9b2731b034..2859f107722 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-RZ gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.mdx index 6618ad19402..6aa75f49bee 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-√X gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.mdx index e83d32e901f..f6fa4d7c6cb 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.mdx index 2c0db0d3637..69fd8c80f65 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U1 gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.mdx index ca397ff19fb..598a3ac2513 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.mdx index 05acb5a7b37..726fa592a14 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.mdx index cd50da2a388..14aafbad86a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-X gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.mdx index de07cae2013..a4a60e39b00 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Y gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.mdx index ab9f3558d28..f2302004838 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Controlled-Z gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.mdx index 1474b7ee7c4..aeb9beb0748 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: `qiskit.circuit.gate.Gate` Double-CNOT gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.mdx index 1fdbc2fd505..5fb9057ef7b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Diagonal circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.mdx index f64a59aad6f..4103fa62e31 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.mdx index ac5490c7a03..e52f69562ae 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: `qiskit.circuit.gate.Gate` An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.mdx index 6f6cf918c19..8c09a781086 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 8dc4d8bc0a8..b9f2e53c9b5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The evolved operator ansatz. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.mdx index d5ab50a1eff..9eb7ad2089f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Exact reciprocal diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.mdx index ef426999738..1748e92f3ed 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.mdx index d006dc68aba..73c36839242 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Fourier checking circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.mdx index f6596072285..c827575c8be 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.mdx index 7fe5619c057..d410c87a94e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GR.mdx index 11ec39ef8ca..a31f54e690f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global R gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.mdx index 23d3a8397a5..c4f553cd2c8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RX gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.mdx index 7d883def64c..49efd645ebf 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: `qiskit.circuit.library.generalized_gates.gr.GR` Global RY gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.mdx index 3a2540f1027..759cd2bd2d6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Global RZ gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.mdx index 0ba4735848d..77ff506a3e0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.mdx index b87ec683f5c..60ebd152dce 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The Grover operator. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.mdx index 04b7bc1c58f..aca23906efa 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 3fcac9f69f3..8a17a281669 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.mdx index 65ef72d9f92..430a22398d6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.mdx index c0d49deb6ff..81e873a2fa3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: `qiskit.circuit.gate.Gate` Identity gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.mdx index 12448661e3d..43e69996b3c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.mdx index fb922858333..6cfaa506693 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.mdx index 16d56b33e43..254038ce22c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 071a1d50945..f8cb914f474 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.mdx index 54fc7028bc5..d4da5eb8089 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: `qiskit.circuit.gate.Gate` A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.mdx index 8bf86de6dd3..5bba4079404 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.mdx index 35b231430ef..a5991db00e8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.mdx index 7db60499cdf..ea222a14388 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.mdx index 31240598e2e..7aad438433d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.mdx index 7f348bfc368..9542bb70892 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: `qiskit.circuit.controlledgate.ControlledGate` The general, multi-controlled X gate. @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.mdx index 553acec6ffa..2a8d47f3a62 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.mdx index f78a3048c47..eff5a13b7b0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.mdx index bcae47380d2..ba17033d455 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.mdx index 1cdac17461a..57f510468b1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: `qiskit.circuit.gate.Gate` MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.mdx index 73ed86e204d..5b4a9b846f9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.OR.mdx index 685635241fd..c956a10b2c3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.mdx index 50e399d02cf..ed8961ecf76 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: `qiskit.circuit.gate.Gate` Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.mdx index 82e6921c3e1..6af5f644eda 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.mdx index e725c1c5fbc..1e50c140f07 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: `qiskit.circuit.gate.Gate` A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.mdx index 6c998f0c7f9..13e415fcdd9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.mdx index 4c9c30aff01..06f91560823 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.mdx index 3ab754c55eb..6bc52638a61 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Estimation circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.mdx index 93351dd1561..ff4bcce7ae5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.mdx index 090c61efefe..a7f36f5c23f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.mdx index f36b79dc52d..4e4af1fd75a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index c33489913d4..fc707701938 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index dd876b9e202..e3bf31514d7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.mdx index 66f7949ffbe..e9dd05e1cf8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.mdx index 9adb91f5aae..813e0e985ee 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.mdx index 1ffcf972f00..7759f2baf1a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.mdx index fc106f4fcfc..13d60bf119b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.mdx index 93bab7958a5..d738c9f833c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` A quantum volume model circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.mdx index aa9b8d82c9a..5c95fd80f9e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: `qiskit.circuit.gate.Gate` The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.mdx index d4049bdd4ac..6a023dfd69e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: `qiskit.circuit.gate.Gate` The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.mdx index 3ed823070ea..a9fe6d33d31 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.mdx index 0b0bc55f398..555f31b4e0e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: `qiskit.circuit.gate.Gate` Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.mdx index 964dec835e2..221abfeebf6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: `qiskit.circuit.gate.Gate` Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.mdx index b45ecda895b..d2d92158724 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.mdx index 191982e5547..62b3daf8232 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.mdx index 6cb1d1bd699..58f8f80cc15 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.mdx index 46ece93fe53..789f6b49831 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.mdx index 5e8cf91cdc1..2cb10edf005 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.mdx index daa52dfe5b8..c59560fc18b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.mdx index 23dbf3e8f81..bbd8831faef 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: `qiskit.circuit.gate.Gate` A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.mdx index 0c0845cb4a5..fbee714740c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.mdx index 2c0b7df9101..473a7c7590f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.mdx index da08424dcbb..e8ba1e2b72e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.mdx index 80bce05177c..9dfa573d3b5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: `qiskit.circuit.gate.Gate` The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.mdx index de124f75857..95793287ddb 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.mdx index c2a1ba169ac..162a6a6f0a1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: `qiskit.circuit.gate.Gate` Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.mdx index 8e917fd1f1b..619a1a6db95 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: `qiskit.circuit.gate.Gate` The SWAP gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.mdx index 0392d5be348..8440447c269 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.mdx index bb29c819410..c630e992a4e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: `qiskit.circuit.gate.Gate` Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.mdx index 5311fb227cd..d7691675c1e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: `qiskit.circuit.library.n_local.n_local.NLocal` The two-local circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.mdx index b87cc62da9c..b04c783f1e9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.mdx index 970e09cafe6..7b42602a2f2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: `qiskit.circuit.gate.Gate` Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.mdx index 146213b2738..7db380f0a18 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.mdx index a9c1d41bcd9..18bb4c245d6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: `qiskit.circuit.gate.Gate` Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.mdx index 09492e8f316..c29ada980fe 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.mdx index b43079c40b3..1516e453b50 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.mdx index f311438cc14..df40d5548d3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.mdx index dfad8844a2c..3985d8a9fee 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.mdx index edb09ad6564..0dfdb7f96de 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: `qiskit.circuit.gate.Gate` XX-YY interaction gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.mdx index 5ddda2d2478..1aab9855196 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: `qiskit.circuit.gate.Gate` XX+YY interaction gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.mdx index 9cf87fd273b..c21fe942c0d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.mdx index ab3f71b121f..80c9d024cae 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.mdx index 4273b314786..ef030c5b547 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: `qiskit.circuit.gate.Gate` The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.mdx index 024c33d024a..399e565a1f3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.mdx index 61b9606389c..9b1b1b0725e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: `qiskit.circuit.gate.Gate` iSWAP gate. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.mdx index 553f6b494d3..5b00d4a655b 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -269,7 +269,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.mdx index 250839a1657..cafce2279b4 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.mdx index 93056beb28f..3a2991cb0eb 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.mdx index 7c1525cb1d7..9de9b230eab 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.mdx index bddc7f68128..97162fd6b75 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.mdx index 720b381c2ac..89b6566153a 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.mdx index 92fdfeddc0b..35593ad4ed4 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.mdx index edd8abd6bc1..b6145af058d 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: `qiskit.dagcircuit.dagnode.DAGNode` Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.mdx index 992669bc5d9..fc7d564ed49 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.36/qiskit.extensions.Initialize.mdx index 0400cbade38..4d448e1c5d0 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.36/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: `qiskit.circuit.instruction.Instruction` Complex amplitude initialization. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.mdx index 50155c5f394..aadf0f9597e 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: `qiskit.circuit.gate.Gate` u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.mdx index 3ffe6f31149..7847bd3c052 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.mdx index 866ce93c958..2f88fe4b695 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: `qiskit.circuit.gate.Gate` Class for representing unitary gates diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.mdx index 92aa0ae0abe..e99f086f5d6 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter # AmpCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.mdx index b9d77fcf22d..4aa6f2b340e 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter # AmpCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 82652e66f58..8804992d5f3 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter # AngleCalCXFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.mdx index babab36fa7e..4482b8d9637 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter # AngleCalFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` Amplitude error fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index 9dffa8bff43..bc8a9c12429 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter # BaseCoherenceFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.mdx index bc9432cc614..0824240c6be 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter # BaseGateFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseFitter` Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.mdx index 20fd6b614f4..fd52ff2d0a3 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter # DragFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Drag Experiment fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.mdx index d9b264711df..150e971e208 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter # RabiFitter - + Bases: `qiskit.ignis.characterization.fitters.IQFitter` Rabi Experiment fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.mdx index 7d567c5bc3b..e8aed31585e 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter # T1Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.mdx index d63d4cf3030..17f9fa43e13 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter # T2Fitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.mdx index 2f435cd2a2c..688b355527b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter # T2StarFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.mdx index 47a64918080..4da5b7c6cb7 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter # ZZFitter - + Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` ZZ fitter diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.mdx b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.mdx index 208fa733911..87f461262e0 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader # IgnisLogReader - + Bases: `object` Class to read from Ignis log files diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.mdx index 829ec37514a..5ca1208f33d 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger # IgnisLogger - + Bases: `logging.Logger` A logger class for Ignis diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.mdx b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.mdx index 39e9f10be13..c819b99ef57 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging # IgnisLogging - + Bases: `object` Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.mdx index 26700712ffd..4652d14b971 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter # DiscriminationFilter - + Bases: `object` Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -62,7 +62,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter ### get\_base - + Returns the base inferred from expected\_states. The intent is to allow users to discriminate states higher than 0/1. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.mdx index 44c959cae4e..43783fc8a20 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter # IQDiscriminationFitter - + Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -36,7 +36,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### discriminate - + Applies the discriminator to x\_data. **Parameters** @@ -54,7 +54,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter ### fit - + Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.mdx index 418d1fa59a2..b4baf74199e 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator # LinearIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx index 932574b4613..2dde1f820cb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator # QuadraticIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx index bc8483eca85..c6901aad408 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator # SklearnIQDiscriminator - + Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx index 4dcd2800ba3..33c6bb81fa5 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator # CTMPExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx index 4dfc095b0fe..730e0b80c9a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator # CompleteExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.mdx index 9dcb94b827d..a4f9fca1427 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx index 6eaff8df214..db6374cd075 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter # ExpvalMeasMitigatorFitter - + Bases: `object` Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.mdx index 0c1b904bb7a..5f4696179c8 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter # MeasurementFilter - + Bases: `object` Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx index ae5e01d4ad7..a7f98e960da 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator # TensoredExpvalMeasMitigator - + Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.mdx index 268a1e17b8c..a093c4a6180 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter # TensoredFilter - + Bases: `object` Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.mdx index 384ac48825d..af0fb218d06 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.mdx index 9bc1e589e2d..d03132df395 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits # AccreditationCircuits - + Bases: `object` This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.mdx index 6364f8cea72..ec898bfe14f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter # AccreditationFitter - + Bases: `object` Class for fitters for accreditation diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.mdx index 38cfe2ebc49..b44e6407e53 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.BConfig # BConfig - + Bases: `object` This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx index 44e365b69df..bf9fbaaecbf 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter # CNOTDihedralRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.mdx index 20f8f282950..b2002c9eecf 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter # GatesetTomographyFitter - + Bases: `object` Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.mdx index b0887c134cd..645f577be60 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder # GraphDecoder - + Bases: `object` Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.mdx index e53f83fb41c..311271a2f1a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter # InterleavedRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.mdx index 49209882f79..6a750eb6501 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.Plotter # Plotter - + Bases: `object` Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.mdx index 07e9a590794..639353483e2 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter # ProcessTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.mdx index e94eb302846..3d214e98ff5 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter # PurityRBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitter for purity RB. @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter ### F234 - + Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.mdx index 4b82f35fb56..4b967d7affb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.QVFitter # QVFitter - + Bases: `object` Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.mdx index 85419233c1a..a43166538fc 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RBFitter # RBFitter - + Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.mdx index 046bb83bc71..466767137d4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode # RepetitionCode - + Bases: `object` Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.mdx index afa75bff6be..4e3a642f9f4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter # StateTomographyFitter - + Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.mdx b/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.mdx index 1d38d8670ef..c28f7b27efe 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter # TomographyFitter - + Bases: `object` Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.mdx index f6285665e44..926585fef6e 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.mdx index c0916b95fd1..5ac6e7523db 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.mdx index 113b99e316c..5478557885f 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.mdx index d4ffbc3a817..14c32ad501a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.mdx index 2e7171592df..e9c131dc799 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.mdx index c55be67fc11..04e9dd76c17 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.mdx index 2a7fbe23620..f55142b7c7b 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.mdx index cfb18206d91..bc84eefb5fa 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.mdx index e4b12a2a7f0..d92d07806b1 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.mdx index ecb920de336..e32c74844b6 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.mdx index e63b95d250f..4520831ac40 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.mdx index 43fe77c2c48..97f7da4f697 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 87274e6c87d..fbdb2aa06dd 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.mdx index 80d952eeb8b..1489637786a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.mdx index 7aae20792ec..453f91462f7 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.mdx index a494c478246..ce028762ed9 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.mdx index 29dff3a4a73..ac7e08f6e76 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.mdx index a39fdb41f05..b8b3a4c66a4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.mdx index 9679ed31e04..2ee8255c3f3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.mdx index 20f653c7571..21d3ac48bd3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.mdx index 3b35d786503..e083da4b09e 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.mdx index 27aaaee74ae..619f14dc9c2 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.mdx index 9aa3f93e4fb..72669c15f3a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.mdx index d6da06e06a1..b34c7cacf0a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.mdx index 3a13db39e10..5a165d26ecf 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.mdx index d638eae1d13..8956c1fa824 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.mdx index a09355f1782..b5d1d401575 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: `qiskit.opflow.converters.converter_base.ConverterBase` Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.mdx index abee321dc01..3ecd17305fc 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.mdx index b8d1aff8b78..3986d72b2b4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.mdx index e5abcf57885..0d05cea34b4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.mdx index 8e50dbdc653..a526e880cd9 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.mdx index 6e31cc09b80..e8d49fbc7fc 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.mdx index 2193dc59871..ac563c0b473 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.mdx index d6f1e80d774..2f0551f88db 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.mdx index 85c503502de..8d74933cae3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.mdx index 4bde58f93fa..48dde121a32 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.mdx index 7f1afebe779..adb31cfda15 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.mdx index 120f6f5fbd7..dcf475a29c9 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: `qiskit.opflow.list_ops.list_op.ListOp` A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.mdx index 2157c17a710..abd6254b94a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.mdx index cbab981be2c..e40561248d1 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.mdx index cfae9d790c6..5ac63037fc2 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 1333beff8b1..3a3b9fb5d21 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index d2e1fb2ef3d..0c7d6c5f348 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 9632b0113ae..163caf032bf 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 0b8b9c28e69..dcd17767eba 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 0830d5ab474..df12540c885 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.mdx index bccbec9fe25..3a18cf32d2b 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.mdx index 3f29cdd2fc1..46b3c3a0052 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.mdx index cf8da0e8d79..3276d29d9cf 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 46f5b07d67f..d0f5110fccf 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.mdx index d4449150d5d..9ec07f2f6b6 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: `qiskit.opflow.operator_base.OperatorBase` A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.mdx index b4cb3c1a635..4aa11d232af 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: `qiskit.opflow.state_fns.state_fn.StateFn` A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.mdx index e578d28688e..b576c580221 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `abc.ABC` Estimator base class. @@ -32,7 +32,7 @@ python_api_name: qiskit.primitives.BaseEstimator ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.mdx index 6efd915b194..08698352242 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `abc.ABC` Sampler base class @@ -28,7 +28,7 @@ python_api_name: qiskit.primitives.BaseSampler ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.36/qiskit.primitives.Estimator.mdx index b5af3e381b1..e6b0bcfe368 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: `qiskit.primitives.base_estimator.BaseEstimator` Estimator class diff --git a/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.mdx index bf62c287ea5..e8056f6de18 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `object` Result of Estimator diff --git a/docs/api/qiskit/0.36/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.36/qiskit.primitives.Sampler.mdx index cd36c8e6a05..d43d2db329b 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: `qiskit.primitives.base_sampler.BaseSampler` Sampler class diff --git a/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.mdx index 8caf112037a..dd6d8eeb4da 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `object` Result of Sampler diff --git a/docs/api/qiskit/0.36/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.36/qiskit.providers.Backend.mdx index 203718d68ec..b9104e22865 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.mdx index dd94ea5666b..a8fc0c9eb27 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.36/qiskit.providers.BackendV1.mdx index cb6002397fc..f5589e2e7ec 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.36/qiskit.providers.BackendV2.mdx index 09d6fe9d97d..39e5534c8f4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: `qiskit.providers.backend.Backend`, `abc.ABC` Abstract class for Backends @@ -148,7 +148,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.mdx b/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.mdx index ba3a8bb9c63..20c79cd0df2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseBackend # BaseBackend - + Bases: `abc.ABC` Legacy Base class for backends. @@ -86,7 +86,7 @@ python_api_name: qiskit.providers.BaseBackend ### run - + Run a Qobj on the the backend. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.BaseJob.mdx index a3236948211..6133bccb9a9 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseJob # BaseJob - + Bases: `abc.ABC` DEPRECATED Legacy Class to handle asynchronous jobs @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.BaseJob ### cancel - + Attempt to cancel the job. @@ -80,7 +80,7 @@ python_api_name: qiskit.providers.BaseJob ### result - + Return the results of the job. @@ -96,13 +96,13 @@ python_api_name: qiskit.providers.BaseJob ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.mdx b/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.mdx index 218af8d7e2b..a9a4dd983c2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BaseProvider # BaseProvider - + Bases: `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.BaseProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.Job.mdx b/docs/api/qiskit/0.36/qiskit.providers.Job.mdx index c0723e6a5ac..20ad90b45dd 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.36/qiskit.providers.JobError.mdx index bda1efc2bcd..120479ad216 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.36/qiskit.providers.JobStatus.mdx index ffdab4ea30c..f066ddcde2c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.mdx index 7f255f661ea..64e4b81d629 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.36/qiskit.providers.JobV1.mdx index 93ad8047945..b0092b422b5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: `qiskit.providers.job.Job`, `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.36/qiskit.providers.Options.mdx b/docs/api/qiskit/0.36/qiskit.providers.Options.mdx index 9a2a51c0089..a6ad3d26e60 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.36/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.36/qiskit.providers.Provider.mdx index 2eb4bfd7ed2..9dd824fa4b7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.mdx index 6f83db0f7f5..cb4c9a75b74 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: `qiskit.providers.provider.Provider`, `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.mdx index 912032a9ee8..56605a57312 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.mdx index d66ffb5cbb6..3a4ec2104a4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.mdx index b4aecfd0aaa..efb82483790 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.mdx index 6ff282b7b69..1199b839fc9 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.mdx index f363c0fe620..a00d39cc07e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.mdx index b6aedd18a7c..c2563e6715c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.mdx index 98d63a8278f..c0c32538a9f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.mdx index 3b31ce7ddc0..391e567364e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.mdx index a6368f4fce9..edd7c7f6db0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.mdx index ea1937c6690..fada3a5f926 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: `qiskit.circuit.instruction.Instruction` Simulator snapshot instruction. @@ -96,7 +96,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index c305ddb6231..0384bd4d71c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for density matrix method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index 7f0cc538b3a..2faa1d0dc29 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for supported methods of Qasm simulator. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index 3d24cd5e0b6..43bb3344e4e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for all methods of Qasm simulator. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index 5411d219e72..914ae33d642 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for stabilizer method of Qasm simulator. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index 6fea0af08bf..bd728d77345 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` Snapshot instruction for statevector snapshot type @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.mdx index 8b7f902dbab..9082e168bcc 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: `qiskit.providers.job.JobV1` AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.mdx index ef1026a89d0..7bbc66a4cea 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: `qiskit.providers.job.JobV1` A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.mdx index 6837cd77a5b..ac67cc9eb6e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 2c9a9ad11ee..45678a8cbb6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.mdx index 843dfead86c..f79e427a7e7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford # SaveClifford - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.mdx index 7b9faccaa48..6e832717e08 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.mdx index 3f3c4b6e12f..011d1cecb09 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 1ae419d3a15..7ac5ba69953 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.mdx index fedf2fe3509..883b99599bd 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.mdx index 6aa89f185cd..f56e0489327 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index cb1f47ef778..b3b6d5f5fdf 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.mdx index 9b94e06b228..44999fa713f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.mdx index 4d619585a07..651e3c08310 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.mdx index 3f925c44191..c4d4bce4ea3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.mdx index 55ee531eb06..0dc2977189a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.mdx index 1fdc362386a..898891749d9 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.mdx index d77642c3706..fc85f3fed38 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.mdx index 239a65335c9..e512fd39ecf 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: `qiskit.circuit.instruction.Instruction` Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.mdx index a724a87f28a..bbef4271e57 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: `qiskit.circuit.instruction.Instruction` Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.mdx index 76b48579e0c..b43c8f7a7ce 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: `qiskit.circuit.instruction.Instruction` Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.mdx index 0e0ab042014..ae144a88ec1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: `qiskit.circuit.instruction.Instruction` Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.mdx index 97dcfb4a37a..ac8b4b6c149 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: `qiskit.circuit.instruction.Instruction` Set superop state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.mdx index af9feb59a12..4f5e09d2409 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: `qiskit.circuit.instruction.Instruction` Set unitary state of the simulator diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.mdx index 97af26fcf8a..cfe7949d3d7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass # LocalNoisePass - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.mdx index e5e3390e56d..cf823eee0c7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.mdx index db307d6cfaf..393379c2e8e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -221,13 +221,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.mdx index 6a2f2f6f5df..afebd359507 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.mdx index 5f8535a159f..7998f7516ca 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: `qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass` Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.mdx index b43821740f7..74ad7242f39 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.mdx index ac87d005db2..7c370cba755 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.mdx index 732d31f4dbe..fc5c1d1dcc7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.mdx index 0d683abb029..377b186cdd8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: `qiskit.providers.job.JobV1` BasicAerJob class. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.mdx index a1352c6a6ef..1416541f040 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.mdx index c9eaed57e3a..147b499bfb3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 2092fa2c3f7..8783de09b15 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 7d8b91ba098..244190f31f0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: `qiskit.providers.backend.BackendV1` Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.mdx index 771c6c96bc5..85caada0621 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: `qiskit.providers.provider.ProviderV1` Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.mdx index 08978953371..c6066f6952d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 77938eed65f..b62debef98c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 08324f4c785..6c1891afb4a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5e1f36a1ef0..11591b97239 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7bd9846736e..086ef5c02f8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.mdx index 5ede14ab55c..021978045af 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index c59e5af9b43..365d96ca0c5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.mdx index 7f5aefe998b..65e5b8c0e13 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: `qiskit.providers.backend.BackendV1` Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.mdx index f8fd56fe3c9..4635a794f78 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index cfa5dc1a253..5d5279797c8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.mdx index 1025e5dab66..5e5087bfac5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.mdx index 2c8db65e91c..beac648f9f3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 467d2398c52..d5b0a4daf6a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.mdx index 0e1a378f9bd..d26ccb56456 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.mdx index 1a497b42f20..433667a2ca1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.mdx index 4e66ec8b9a1..32c8d2d7dd4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.mdx index d1b67858f1a..af42a346be7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.mdx index c4aa52f6b05..9ae4c8afb7c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 18cce35ed89..73a0f0e6ff5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 43ba66ed697..0d799ae020f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 0a14a917596..972837399a2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 6fb7ea75087..240333075ca 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 8eb4301abf2..44b546c722c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 644d3507432..73ae596305f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 3806bb8f5a8..167482f59ea 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index 6f8904230db..eb07e4b1863 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.mdx index cf73bb34b57..ee1c3c2481c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.mdx index 125c0bf15b7..8887c1bd39a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: `qiskit.providers.job.JobV1` Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 35a0cc6ba99..8f64345b896 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.mdx index 47dd3486da9..356a036be9a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a241f50de8a..95749d75f86 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 03fc1cf820d..bea5ed64106 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 7a9308801b9..39107919c9c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.mdx index d01acdace81..1206689f3a5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index c0ebf699313..4ef92c6e762 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 68fc1e67894..84038a821cb 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 67ed3ea14c8..72c9835f3a7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 8003237ebc0..c16e4af1d0e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 09e5727ca8d..190201a49d0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 0dcb7a64379..bc551f07f60 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index de50c05e444..ceacc699e63 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.mdx index 7f3b8dfb757..608cbd97344 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index 68f88b211d1..ad00167775d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.mdx index 3119c21919c..28333d32b04 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 0ad85ad819f..8d0182b2481 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 81c7ede59f6..797d9fbd982 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index 9a85f84ca2c..fbdd4bcbfee 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index a0adaecb07a..5b885f2d779 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e79f25b1745..d9be3834224 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 3959fb827aa..e891cf63722 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 98856bf90bd..88dca1037c3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 526e10d5308..9b86a18a7cf 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 0bc9732f82f..e425b402871 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 0f827e65be8..50d91643724 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.mdx index 1db1e21762d..494c08b9ebf 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.mdx index cf7f435996d..18745049615 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.mdx index 990ab4d8585..88ce9fae43e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.Command.mdx index 86a6e36d89d..b0c6ff20566 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.mdx index 4555e839a65..b91bce468f1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.mdx index 5509866e6bf..84b024099ad 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.mdx index df2b869c772..5e9e7c22dbe 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.mdx index 170182f6974..ab2af388c49 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.mdx index e08f510e096..c33ac5c402b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.mdx index 2cefbabbfe7..4dc056e13c0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.mdx index 82b7916f7c2..f1678648b9b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.36/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.36/qiskit.pulse.Schedule.mdx index 366d240917f..dc28ad618f0 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.mdx index 6d2e6b5bfd7..1b8728be1ad 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `alignment_context`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.mdx index 26bd3e526a3..4ac670adb3e 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.mdx index 19ed18d4edc..a8a1ddb7596 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.mdx index 5daaea04618..f76d2afe3cd 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.mdx index 40e7be7e551..88fb9fa2da9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.mdx index 7ac432a9ad5..25c25075797 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.mdx index 2b79dc879f3..65c5cafdc53 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.mdx index 352d533bce6..2f1dea34adc 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.mdx index 87d03c5e4b7..747de4c36fb 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.mdx index cdd2eca726b..58197c07921 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.mdx index b9dce2e9a45..819098b8a6c 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: `qiskit.pulse.instructions.instruction.Instruction` A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.mdx index 7a993e5ad88..feaa8d29020 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: `qiskit.pulse.instructions.instruction.Instruction` This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.mdx index 58fe05e9a6d..d16ef593953 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.mdx index e9625c894da..5455acddbcf 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.mdx index fa32727712b..1bfd024f5e9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: `qiskit.pulse.instructions.instruction.Instruction` Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.mdx index ff472c580ed..1eebe796847 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: `qiskit.pulse.instructions.instruction.Instruction` The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.mdx index 73596fd7588..52152f7eb11 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: `qiskit.pulse.instructions.instruction.Instruction` An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.mdx index f9e9336cbda..d1bc7648eb9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.mdx index efdfc075093..dcf03e7840d 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.mdx index 2b6286bb417..1867f0271c6 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.mdx index fb7e33fea45..85686a11871 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.mdx index d765e01f7b4..5d3a37a9eb8 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.mdx index 435efdec536..60153de449e 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.mdx index e4e91b60be5..1e9eb2934cb 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.mdx index 64debdb8c61..116c52c59fc 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.mdx index 27f7797c740..3b48b76e5b5 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.mdx index c39359798a9..b96deea6d52 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` Align instructions sequentially. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.mdx index c5f6ef78e77..7667352070f 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.36/qiskit.qasm.Qasm.mdx index 54130fe72ec..c706fafe4c5 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.36/qiskit.qasm.QasmError.mdx index 78303b9dda2..d67ce3063b9 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.mdx index 3c7374cec01..4fc904b243d 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.mdx index 9bb416d307b..c4314d4ddbd 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.mdx b/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.mdx index 63df520c933..124a5c40660 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.mdx +++ b/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm3.Exporter # Exporter - + Bases: `object` QASM3 expoter main class. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.mdx index 78e05f5b08d..bf90562c426 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.mdx index 8f107e797a1..165228792c4 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.mdx index acb97a97e24..f03af86a838 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.mdx index 2854cf19f66..be426d91b4f 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.mdx index 4840c768d6a..2fee3386fce 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.mdx index 0e12582c59a..62286846c45 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.mdx index 2f360276a1d..6e3e92f80c4 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.mdx index c8f88b3d8e2..c5df92463d3 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.mdx index 4f8b66b3f9b..e4c8d7b7200 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.mdx index 839e374c013..2c1bc4a96a0 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.mdx index 671c052242d..03469ebcd2f 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.mdx index 1a2cddf1981..c7d56f75b0a 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.mdx index 9abc9257017..1dc83966145 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.36/qiskit.qobj.Qobj.mdx index 9f2e3258813..e1ec6c1e3de 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: `qiskit.qobj.qasm_qobj.QasmQobj` A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.mdx index d01685f8be9..153ac72852f 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: `qiskit.qobj.common.QobjHeader` A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.mdx index e93ede4f247..387c371137c 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.mdx index 1a8bd43b86d..a9e3791f88c 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.mdx index 960a2218900..c5672dcdfee 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.mdx index 3a4c1fc8bb5..58e958d2b9e 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.mdx index caba42b377d..363214238b5 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.mdx index a93989afeed..99c1ba74809 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -157,7 +157,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -179,13 +179,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.mdx index 625cfcefd67..1b929614cb2 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.mdx index 709b979c7bd..1daf7efe54a 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 71bd9fd7dbb..4b24642b478 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.mdx index d0ca8553410..4a980f8d514 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -152,7 +152,7 @@ $$ ### from\_circuit - + Create a new Operator object from a :class\`.QuantumCircuit\` While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -176,7 +176,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.mdx index b786204ffb0..44819341f7e 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.mdx index ee1e7ebf6dc..11f7dc30245 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -338,7 +338,7 @@ $$ ### from\_label - + DEPRECATED: Construct a Pauli from a string label. This function is deprecated use `Pauli(label)` instead. @@ -458,7 +458,7 @@ $$ ### pauli\_single - + DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. **Parameters** @@ -500,7 +500,7 @@ $$ ### random - + DEPRECATED: Return a random Pauli on number of qubits. This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. @@ -545,7 +545,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -559,7 +559,7 @@ $$ ### sgn\_prod - + DEPRECATED: Multiply two Paulis and track the phase. This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.mdx index 896b2dd7a58..4f969e11853 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.mdx index 7740b4f25e2..42e3b6d9b66 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.mdx index f9791b375e7..1f382fd2fe3 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.mdx index 1cb78ee8943..01478bc05e8 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.mdx index 5789638bb6c..269f27f72e0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -172,7 +172,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -207,7 +207,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -233,7 +233,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -407,7 +407,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.mdx index 49d8adf9ade..c869e2c74cd 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.mdx index 213cedd753e..2021bb33d6c 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.mdx index 140b89ef4ad..7cee62a391d 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.mdx index 3b28b3fb532..78af9dd68c1 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.mdx index d806d7e6325..b346dbb43f4 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 5c07824f23e..6ab6dd4c0e8 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.mdx index cb6b7bf9f6e..02c4fd2dff3 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.mdx index b4bb1e2db7f..d6ac062fdd9 100644 --- a/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.mdx index 81747e9fc9a..6ea36213d32 100644 --- a/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.36/qiskit.result.Counts.mdx b/docs/api/qiskit/0.36/qiskit.result.Counts.mdx index efe402d9b77..97ece81eb59 100644 --- a/docs/api/qiskit/0.36/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.mdx index 85b12edfbf8..46a6f7e8cca 100644 --- a/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.mdx index 738ae26b686..d3d1f27af79 100644 --- a/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.mdx index 12bae05ba76..eb0bf6a21ec 100644 --- a/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.36/qiskit.result.Result.mdx b/docs/api/qiskit/0.36/qiskit.result.Result.mdx index 102ec04b453..128caa427e6 100644 --- a/docs/api/qiskit/0.36/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.36/qiskit.result.ResultError.mdx index b334d8fc6c9..e49d074d3c9 100644 --- a/docs/api/qiskit/0.36/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.36/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.mdx index 6c2469d12a7..fe276b9be3d 100644 --- a/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.mdx index 259e763cb7d..7654af97806 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.mdx index 9367247601f..d29ab7ec4eb 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.mdx index 6630063bd03..64cfac9e59a 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.mdx index 41fe8adb370..ac528eac137 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.mdx index 47035687155..e986e9d2f2b 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.mdx index 98323a8dcdb..e1cdc28a99e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.mdx index dd22d653346..6bfb9eb6c29 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: `qiskit.transpiler.runningpassmanager.FlowController` Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.mdx index c3e04196dd7..24343e96d4a 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.mdx index 06e05c2845a..dfc5e77e9bb 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: `qiskit.transpiler.runningpassmanager.FlowController` Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.mdx index 2d2027f0e49..f5726eb002d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.mdx index 4b5df9c3654..b99f4b15c5e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.mdx index ee3ec0ae095..344bf46efd2 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.mdx index 45f9fe7b65a..e1d3b4f7b82 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.mdx index 451034e4f71..3391059f457 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.Layout.mdx index d572e890332..3af697c6fa5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.mdx index 1f97087b50a..34c3dec3175 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.mdx index b979a17b19b..2aae0de8877 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.mdx index e0d91c4b5dd..bef72a4d905 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.Target.mdx index 9c94abf1f2b..7c972c8a7d4 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.mdx index e00f098ef45..4047f4d0ed4 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.mdx index fb90f60bb4b..a43d242ffc5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.mdx index 496c39663f6..71ff4e76fe7 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.mdx index 6d4c9b3a339..e2f6788c0cd 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 036755cd1b7..ed35dc12f91 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.mdx index 6be07de8a6b..1f267369348 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index bbfa808b078..9f75b7c9d74 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.mdx index 3e2db00ea0a..8bcec25892d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Measurement alignment. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.mdx index 274410d707c..05b15880ad5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.mdx index 407a8e0c676..443b7bd8aab 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 382629b90df..c7658ffee3e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.mdx index 662b3636174..2d96779abf8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.mdx index a046a8a6b53..a334a061d02 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.mdx index c8ed6f773b1..50ac110d894 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.mdx index 34fc7abe5f3..8153495775d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.mdx index df785f5c36d..b286924368b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.mdx index ff601e326d4..e912d1a0473 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.mdx index 06348a11c48..1e8d81eb786 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.mdx index ac4328f3d3e..3b891010fb9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.mdx index f6109f57f7d..87dca89c701 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.mdx index 03efc3b4503..bd413668691 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 3f17bae9e54..64858e69000 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 945b1012394..c49960d8372 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.mdx index 1b6fcffb0e2..a8d63e910ac 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.mdx index 444f14aac1e..00b9e0adc48 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 5a81883f825..091e35175f8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 789775fabad..217c082f6a3 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.mdx index 6fd5e64cc49..e8d12614b9f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.mdx index c188c4f6249..c98db5338b1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 10274cf3d93..2c1492a6d37 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 51f6bdb6b5d..a0d68f5c7c8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.mdx index 3898f776922..bd4a6dc76ef 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.mdx index bb0cf279e51..76daed840c5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.mdx index 3f9b912c132..f4550bf217b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.mdx index 86f100a4693..fa3cfd5cda9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.mdx index 0304bb65688..b2972efc98d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 60f5f1ba461..cb80898e3c8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 10fbfa8e1ab..dc749a5fff7 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 19a891c923b..3f6c3a323d5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.mdx index 3dafead0f36..d4d2b2f0941 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 0aba195e478..152ec95eb1c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.mdx index 60a8270ab19..c52a50a66b1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.mdx index e2689559158..572a9af034e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.mdx index a7ce0b5cc0c..58f04bb2200 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: `qiskit.transpiler.basepasses.TransformationPass` This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 0657f12382c..2ed3cfadcd7 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.mdx index 0f1afbd14df..2f1493ef805 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.mdx index d0776f6c1d9..89d7ff5158d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 79409e385d5..f50566964df 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize linear functions. Under the hood, this runs cnot\_synth which implements the Patel–Markov–Hayes algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index b8d4cb7c73c..6e931804a56 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.mdx index 9b3d5f5f330..9822f2b4e15 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index cf08fb072b0..7bcbbdb1fa5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 9f69da16988..629afcf20bb 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.mdx index 6686a218763..35441518d7d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.mdx index cb3b3679160..89eb760b5dc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index ea1891f474d..a0d36d5fafa 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 35210c8712f..7866f671f30 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.mdx index 2b4a097394e..129e9db13df 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index bd5133d7932..3eb0f8d425d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.mdx index dfec0488e39..32932ce1fef 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index d0a3fd6eb99..0ac577faaf8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 788a87272e2..a1130bdaea4 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.mdx index 6da85fbd773..4940bfdc785 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index aef8252aec1..8ff5a71af45 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 03e45472818..bbbc1a2e53a 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index b551bc111bc..e2560626256 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.mdx index b72c7b4cd06..0aa746a3c72 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.mdx index d3f9552bbb0..c836b3f0420 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.mdx index 3348a569d2e..009c0983403 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.mdx index 2b31e4a37a7..6ab2a332c00 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.mdx index 56ff3b59f16..cd3fdf27dc6 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.mdx index 664cd18a021..b80e122d945 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.mdx index 77ea6db4e26..717d64b8041 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Class for the template optimization pass. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.mdx index 9ee656572ee..f0be61ac77a 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.mdx index 9156a5d8230..02acb6874ce 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.mdx index 1142c426f02..2b83417671e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.mdx index aaa29f7a0ff..b740cc48a30 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 7618e6d7235..51b3d434a09 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.mdx index 4b16a6ab87e..7228652f556 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: `qiskit.transpiler.basepasses.TransformationPass` Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.mdx index e5f9300a7bb..5e6fe4c9bab 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.mdx index 22448b8991c..1099d704226 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Check custom gate length. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.mdx index c1c981f065e..fe1b29ab386 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: `qiskit.transpiler.basepasses.AnalysisPass` Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 3002e973639..ed4fab9dec1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 71c6c4a44c8..7aa0b1d5ba5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.mdx index b400b7ca384..d6694d72575 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index fb37e08af24..824e4deadc7 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 9bb9c2416b9..84f5031f78c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 1e46a533efc..77b8f2d0c73 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 0980a6519cf..267d44ff0d9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index e645182e1b8..8c16d017594 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index 135e328021f..1d8ffc58027 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.mdx index 4a468aa4621..f30bf4c71df 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.mdx index d6f96ee3496..1a5dfcc27dd 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 50c9dcc0863..b45a39f221e 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.mdx index 4672646fa15..fb1a0a76b30 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 03480323590..0bf7b342d42 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.mdx index 57cadf92efb..f831cc0b7a0 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.mdx index 13c825f4af3..327c3b43c30 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.mdx index 7eb862f0f22..2d065c717bb 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.36/utils.mdx b/docs/api/qiskit/0.36/utils.mdx index 40ab693439a..e8e401f9938 100644 --- a/docs/api/qiskit/0.36/utils.mdx +++ b/docs/api/qiskit/0.36/utils.mdx @@ -107,7 +107,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -147,7 +147,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -214,7 +214,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -228,7 +228,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.37/pulse.mdx b/docs/api/qiskit/0.37/pulse.mdx index 87bdc7b85a8..73750109f86 100644 --- a/docs/api/qiskit/0.37/pulse.mdx +++ b/docs/api/qiskit/0.37/pulse.mdx @@ -66,7 +66,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -226,7 +226,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -668,7 +668,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.mdx index 6ff1019c8bd..e795f0f9431 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.mdx index 2a4e07527b2..03a9fff237e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.mdx index 3173c341c90..0a40c9b69a6 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.mdx index 23928894164..cf73d7c5075 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.mdx index 3068ef4d09c..37d965aa0f8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.mdx index 90d8d7f8dc2..9f2042378d9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 6d3271fa435..6e4503b2bf8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.mdx index 569fb27825a..2e2d419c16f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.mdx index ac261ba61af..5fdc7348a23 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.mdx index 97ab8615264..d886a239016 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.mdx index fe5beb8ef82..23ea8af8cc9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Evolution problem class. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.mdx index 7c73b11fb2b..c571cb4591a 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding evolution result. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.mdx index af534df3896..b998c31c97d 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index b4222fb9421..8fdaf612623 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.Grover.mdx index f60e272cfce..3ea10cd5b4d 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -135,7 +135,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.mdx index c7c4b5dbe99..14d4e83676d 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e651d910d3d..e2c1842dd81 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 282bcb9d417..da5fe41e64b 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.mdx index 52a82c4c162..cc43b7f63a4 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index e9bf1c02b21..22baefe6604 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 5503b197356..27939b97bc7 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.mdx index 5bed0f86fc7..c1ff86b4939 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 366eb97a052..8bd59c5167f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index d10bfe48bcb..858183b8e89 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.mdx index efecd6ad63e..10365c08f01 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.mdx index 3edc5f41ed3..4643c430ab7 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.mdx index fd8af2bea39..ad2cf9f3ab4 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.mdx index bb67a3ae297..3fdb36b72c0 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.mdx index 0edec4f5d47..52a7d1e7408 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.mdx index 87d5020d2be..f179c5d26b9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.mdx index b182534ed9b..6b70bf75a63 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.mdx index 992e1c13d88..367a1adc469 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") The Quantum Approximate Optimization Algorithm. @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.mdx index b4223cca0b0..65fd9d8ed41 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.Shor.mdx index 7ec301e1475..c47cb76765b 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.mdx index 34815eb4625..064fcd5ed5e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.mdx index be9f2f1d9a9..ba13f3ee123 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a ProductFormula provided. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.VQD.mdx index 21232114e70..dd3768996d3 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") The Variational Quantum Deflation algorithm. @@ -146,7 +146,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.VQE.mdx index 02114ce0613..83f9ae574f5 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") The Variational Quantum Eigensolver algorithm. @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index cb60cbca0ef..35f63dd1fc1 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") An observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.mdx index e9dff5d46ca..f53e3b018d9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.mdx index 0396f6cd857..0942f8c8c05 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index b37483302df..df6455a9af2 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index 81ef42e7414..496ba2287f8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for linear system matrices. @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -344,7 +344,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -354,7 +354,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -471,7 +471,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1076,7 +1076,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1218,7 +1218,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1236,7 +1236,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -2051,7 +2051,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 74aafe842d8..4954dab4cb5 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` An abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 3f27843d1d6..bfe8c2447ba 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") A class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index a39702595fd..3a8610a5fd5 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index b56ce9f391e..49d6ae5e5c6 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") Class of matrices given as a numpy array. @@ -281,7 +281,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -367,7 +367,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1241,7 +1241,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1259,7 +1259,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 4ea03562887..77844dbdd63 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") Class of tridiagonal Toeplitz symmetric matrices. @@ -294,7 +294,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -380,7 +380,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -390,7 +390,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1254,7 +1254,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1272,7 +1272,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.mdx index 25c364fb8d2..3cdb05f1a88 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.mdx index 62b547f2577..6dcb27357c8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.mdx index f9e5352b4c7..71f74566eb2 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.mdx index 1fb4bc46964..37777d7fae7 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.mdx index 2cb197aeb5a..95a048fbfef 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.mdx index a547c88e2f5..ae7b8f59373 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.mdx index 721c1e8a4b5..4283a6c6124 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index edf189e1af1..12cf7b16da2 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.mdx index 03bf9b91c2e..0fb99f3790f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.mdx index 7bec24640f1..f5bf3f0bd80 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.mdx index 29e891170b9..a590dc4d3c4 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") The gradient descent minimization routine. @@ -96,7 +96,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -162,7 +162,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.mdx index 734ac7cdfd4..ba636a21cda 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.mdx index 3c173dca901..319dc9c1d7e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.mdx index cf27300f1c4..8486d535b90 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.mdx index a2de0104b9c..547293e80f5 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index df580b9a606..47dbca48603 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx index 4e47394cf11..f36be0910a1 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.mdx index 1e86e3520c3..859e20a7c49 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.mdx index 4d1c5a537b8..beca98fc266 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 1c1c4e62de2..677b656c6e0 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.mdx index 1e239a97e77..bf844ffcd18 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.mdx index b9411efa192..3f2d38c3cbd 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.mdx index aea99b49bd0..8326313a76c 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -106,7 +106,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -116,7 +116,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -150,7 +150,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -240,7 +240,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.mdx index 8937647e0c0..7f45827dbd9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.mdx index 8c4291da8a5..69ce727a493 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.mdx index 1ca19e5f133..1d9ec4b91ca 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 01ec99bf809..85709ca51e9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.mdx index a3de83d4271..2f198b95662 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.mdx index 74311450bf6..2d5de27a9c4 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.mdx index 0ce7289f857..ca515072fdb 100644 --- a/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.mdx index 44550b18dba..38f1580ba9b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.mdx index 42030cf3b85..89ed7c78f75 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.mdx index 961ab342e9e..7c66f93e5b2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.mdx index 8a921b87da0..5f05c917c88 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.mdx index 4d5f6e82e33..6143dc8886c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Clbit.mdx index c437db05e23..e2c35437972 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.mdx index 7c83e27b2c5..bc1f62622f8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.mdx index 56ec7965e6e..6f98c6c6b41 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.mdx index 3dd8a4890f9..64149632845 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Delay.mdx index e4d7d691e87..ef29c18900a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.mdx index 6072eb65edf..34db4f912d4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.mdx index 5b2cd1ead1e..48211691d10 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Gate.mdx index 5ff1195efff..52608ac79dc 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.mdx index 648450f758d..5212314fcbf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Instruction.mdx index 7f0de20fe86..432d10c5c9d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.mdx index 8ab61751a64..29508043bff 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Parameter.mdx index b8ee23413ba..6713ffa2237 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.mdx index 4feccaa263f..e43d7bbd435 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.mdx index 41eeaa269b7..ad67c2c8746 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.mdx index af6d7e22b4e..913dbab467a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1296,7 +1296,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1314,7 +1314,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.mdx index 3c09580999e..a5a24b0c872 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.37/qiskit.circuit.Qubit.mdx index 444ec89fe81..f7afc349919 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.mdx index 21dd44bd601..2867a470667 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 82d0397a8c0..a9a3711b86d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index c93b7e93040..1f9a9f273b3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 7901384e04a..c95cb7b0a5b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index bbdf5a84a13..fb49f4f1c3a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.AND.mdx index ffd95f22dd7..5b4f6deb39d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.mdx index d22bdfd8982..73afb0efc09 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.mdx index f25bcb78fd8..6e24e85a5f2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.mdx index 607c891c4c4..1eae722b619 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.mdx index 01674031ad4..f0298e869d8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.mdx index 9b40dcee39d..46281475037 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 8cff5bdd8b6..35875cd22f3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.mdx index dad09671a05..164f222f852 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.mdx index e1661ae948c..e457682e978 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.mdx index 62836e3d7d8..2d5e34ca568 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.mdx index 77dfce287da..604ad4b8d73 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.mdx index a3b8b055df8..4be458e9023 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.mdx index 6742eb7ac82..64de53b9fa7 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.mdx index 0192f18372a..b3b70e9508e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.mdx index 714e4ba3907..2cd80481a63 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.mdx index 3f52516cc2c..55eee83a0d8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.mdx index 3570d12b8f6..b4ac44ff61e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.mdx index 3cdb8d3c75d..03687969b7f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.mdx index 01ef9c56f66..fb60d32f186 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.mdx index 395919b0fd4..89686d1d9b4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.mdx index 1513b02b8aa..f6f394b9bc2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.mdx index 419b91c3715..30b9c7eb60f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.mdx index 04a090a9bda..6e681cb5e0e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.mdx index 513b305bf43..b3cd6db247f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.mdx index 2695e1aa906..531853ae921 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 2c12e23da1c..2d1195ceef0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.mdx index 1f747a87ac9..e6f162ab576 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.mdx index a4b41d277c7..015a8a3ad8e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.mdx index 966a4302a6d..bd3cef23c32 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.mdx index 8fcf1c60206..98da8bb0db4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.mdx index 36d3094116f..46969f1592b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GR.mdx index b8a68146b72..4d8832b9ecb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.mdx index b4fa265b4f7..8122305c5a8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.mdx index 8edabb40521..a5190fc1abd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.mdx index 114940e1f70..3724424efcf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.mdx index c3d9a041f48..7bcf779e380 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.mdx index 3c06b458487..2b1969a8561 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.mdx index afc39b53506..fbda07fa2fc 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index e6c3b23de0c..237f497c4cf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.mdx index 4f72db839d1..99f24baae31 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.mdx index 27d4092e304..4a93a1532a9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.mdx index c94a3230f03..b63ed39f851 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.mdx index d61538b27e6..1cffeaaa02f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.mdx index 32940f139bb..a00e85c1bcd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 616963c4ebe..8ad3960845a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.mdx index ae192f92e8f..ce16735e7e2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.mdx index 0d72dd4d561..b97fb88de4a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.mdx index 5a4c276f369..35dbb9aa136 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.mdx index 84d5fa9c04b..bc1981bbb9c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.mdx index a368814c862..e983bd4da1c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.mdx index 2c6c154fcd3..8b95caefc67 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.mdx index 7d21e15e3a5..0cda3d6019f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.mdx index 2f52fc2c36a..8ff1df12489 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.mdx index 25d11ba0678..72a788e4833 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.mdx index 4e80b724962..eeb254fc5b9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.mdx index e6516af58e9..d6fd835e33f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.mdx index 2821a5f2b13..292215d6f17 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.OR.mdx index 1e9425ec7ff..23cbcfbc5c5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.mdx index 03b48179f13..5aa142f7fd3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.mdx index 91593ba7055..7a63f367ec6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.mdx index acc63d00660..617a6d42640 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.mdx index d9d4e2e1e1f..122595ea074 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.mdx index 54728281c45..68170a02552 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.mdx index 129f676c707..adba12efbab 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.mdx index 60d1de637de..523f6b66cde 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.mdx index 98d5402ad71..71cdf6acd91 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.mdx index de3cc6cef7f..7c78b4a39f2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index d77145b41d1..e973ce86e53 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 719cb5cc963..8032e35234f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.mdx index ddcf910f594..99093a47df1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.mdx index 75ef5e5c276..18cf1440bfa 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.mdx index a211d581338..98b850accaa 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.mdx index a7f8d68c521..4ad3e99c9e4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.mdx index 3c8f03f2703..46093d9ae81 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.mdx index 7aeb4e5e52e..b81595f36f5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.mdx index 15ed3963d97..2394de6ef9d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.mdx index 95cc1a82b8f..8101053e278 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.mdx index 611b0d0152d..ca1e07e896c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.mdx index fa649c62988..193342e6565 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.mdx index 0462a0b883b..3e2109c817b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.mdx index e22fb2e5232..2b02594684b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.mdx index aac75e94233..ca87cd7b600 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.mdx index 172982abecc..900698476cd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.mdx index 24b84ec0998..7cefceb79e1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.mdx index a23ced892c1..f71b5c700f3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.mdx index 350a5e1690b..15903be94eb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.mdx index a346d8a3a39..895d607a5bc 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.mdx index a45cf9ded1c..c934bde1a52 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.mdx index 6bee625042b..a66e36ad06d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.mdx index aa24fd4aed0..8cc5f225078 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.mdx index bd5f303bc49..a83831cff12 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.mdx index 384d7a1410d..862b538429c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.mdx index 90452c7f355..dff286e77d1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.mdx index c139e3fa28d..d645199a669 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.mdx index 50e35fb6171..53ab8a63d73 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.mdx index d83513aa490..dec0262faa8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.mdx index 4a73265ca33..2630b4c5453 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.mdx index 77d2383f08d..0d481d024b8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.mdx index d6b02d807a6..a7b09c17520 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.mdx index 5886ed1d9c2..1db5f1e1ac3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.mdx index 04d7d56c426..9b304eaa0fb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.mdx index c622cd6125d..277f9770a77 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.mdx index 5fdc95de6d0..b82bcff72aa 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.mdx index a2c4e8dd54c..a7cc75b46a6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.mdx index 8cf042df3eb..7584bdda00f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.mdx index 3b2eb07f3a5..be4ee1cbfdf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.mdx index 3771a0136ae..b45dfb39171 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.mdx index 1871f83b962..4850964b9ce 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.mdx index 4728de84985..b71418ef542 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.mdx index fce1eee772e..cd1e8546fc9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.mdx index b707f0e9490..da892e20108 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.mdx index 6de709c68d6..23cdcfd4002 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.mdx index af715f15111..404dbd83b01 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -269,7 +269,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.mdx index 4e2fbb1dcf4..a03417b344e 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.mdx index 06510850d1b..686e254e295 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.mdx index 4f4063b63d2..f2d29ea6012 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.mdx index bade0f5325e..db3a9274e42 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.mdx index 720b0feae9b..66dda14f456 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.mdx index 1daa2325563..190be183c57 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.mdx index 0dbd8829da3..c39eb7d4a08 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.mdx index eb63178a944..1fe749979c5 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.37/qiskit.extensions.Initialize.mdx index 88f2ac8ace3..8ffbe55ad8e 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.mdx index b870d9c959b..9f41b816f47 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.mdx index b8bb383ad44..9841376c7d0 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.mdx index a15edcccd95..c432e864d9f 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.mdx index cd4595ed2da..f3a3f74c2f5 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.mdx index a02e63ef0fc..8fff3d7465b 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.mdx index e358cabe5a9..c65b5b85f34 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.mdx index f288506d176..6eb11f93f9b 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.mdx index 71e34e36445..a9c61f51a12 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.mdx index b35417007c7..c37f2dc6e8c 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.mdx index 4407c70f6fa..98043c28130 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.mdx index da11dd99e2e..71d90b1bd28 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.mdx index 57c8fdc75b3..2bb47d6d231 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.mdx index a2067758210..b516756c9c9 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.mdx index 293cc31e547..f270bc65a3c 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.mdx index f2ae54ea14a..13635f66f0b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.mdx index 2088a7e673d..12867dc71d9 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.mdx index 04d1eb0a986..56218795dc0 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.mdx index 288d02baedc..9b0d8443b57 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.mdx index 606adf9a69d..2b038020fca 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index ef1dfdcc201..fe39da83420 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.mdx index 76d99b03c73..1853e99b554 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.mdx index 24b85a8e04d..a425253e89e 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.mdx index 845ce5a383c..f7c3f28d42f 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.mdx index 11afac9ba91..a9535bc015a 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.mdx index efec9c93168..bb778c91b65 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.mdx index bffb9227216..be7774e8b64 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.mdx index 1d48fb7f1ff..b1e75d1b015 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.mdx index 87f3fea5b6d..2699024abb1 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.mdx index d8253c4b265..3b574956a04 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.mdx index 1a91ff802e5..f0aa4c6b8f1 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.mdx index a298c32185e..12fbe7006c4 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.mdx index 9f88287d773..a343d69ba6b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.mdx index d4ea3fab205..ed5cdab575c 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.mdx index 14d418e9f68..fd2731b2911 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.mdx index 4d8cbef3554..8f02c7a76be 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.mdx index bb03015b29e..347de2a9e4f 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.mdx index bdbe0660857..cd94f735354 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.mdx index 88cdc0674ce..57c1a69345e 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.mdx index 22fdf62b89b..7028b0b71ac 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.mdx index d42c0a9dae0..5f6736212a8 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.mdx index 09761634a9b..c5435cb58b4 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.mdx index 6e5fd1342a3..cf502cbe72c 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.mdx index 5cbf508e170..77776384b91 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.mdx index 6544f395b21..ec8420798ac 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.mdx index d29856fb8fc..5411d370673 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.mdx index ef1311f7a09..52a738dc7cf 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.mdx index e5cf2d15bef..3d15db94029 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.mdx index de0bbc766c9..1099c8ff01b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.mdx index c494c57758e..b34ed35917b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index ccf7faa5ffc..6d9027413a7 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 6a5fc495fb7..24fc4d49ed6 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index bbc6aab12cb..2e6e82de4c9 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.mdx index d0afde61829..0e20176f22c 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.mdx index 8b1b381ba54..67c675ef5bf 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.mdx index fc920789b95..d2317afe605 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.mdx index d646ac12691..67b933c2ec3 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index ade1d34e002..afaa0392ce7 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.mdx index 12f05fa531d..fc9c932c8c2 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.mdx index 6e18ad4aad5..27bf9aa0b36 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.mdx index 49fdaba8fd3..fc397db424a 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `abc.ABC` Estimator base class. @@ -31,7 +31,7 @@ python_api_name: qiskit.primitives.BaseEstimator ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.mdx index cbb40c8d714..a91aac6bbc0 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `abc.ABC` Sampler base class @@ -28,7 +28,7 @@ python_api_name: qiskit.primitives.BaseSampler ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.37/qiskit.primitives.Estimator.mdx index 01536255ed5..b4e86405dd6 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") Estimator class diff --git a/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.mdx index 140cc8cf039..b86c0ffac7e 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `object` Result of Estimator. diff --git a/docs/api/qiskit/0.37/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.37/qiskit.primitives.Sampler.mdx index 7e38f71dfc0..00a4c3079ab 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") Sampler class diff --git a/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.mdx index 7493f4fd427..2c104753857 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `object` Result of Sampler. diff --git a/docs/api/qiskit/0.37/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.37/qiskit.providers.Backend.mdx index 3f37e941bf4..7598dbf54e3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.mdx index 84e22faaa3c..b09f2d6e2a0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.37/qiskit.providers.BackendV1.mdx index dde4fb9634e..258314c26fa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.BackendV2.mdx index 27ab0433917..798edfc5d5a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -148,7 +148,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.37/qiskit.providers.Job.mdx b/docs/api/qiskit/0.37/qiskit.providers.Job.mdx index 67ec05826cd..f9d652d0816 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.37/qiskit.providers.JobError.mdx index fb05309a325..c555061b2fa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.37/qiskit.providers.JobStatus.mdx index ba74521d091..ebc4e347689 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.mdx index 19cf3498d1d..6d7b7af353f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.37/qiskit.providers.JobV1.mdx index f3ede6e3989..428804e60f8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.37/qiskit.providers.Options.mdx b/docs/api/qiskit/0.37/qiskit.providers.Options.mdx index d6545475929..9730eae3a9c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.37/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.37/qiskit.providers.Provider.mdx index 41e8845a9bf..a549bb466ea 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.mdx index 20b08c6a234..10c02c54053 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.mdx index 01c2ac4d005..0d2859e631a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.mdx index 47c0bf6c0b3..f4b6315440e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.mdx index b4aecfd0aaa..efb82483790 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerError # qiskit.providers.aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.mdx index 5769f8c3d14..f402da8b518 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.mdx index f363c0fe620..a00d39cc07e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.AerSimulator # AerSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -228,7 +228,7 @@ python_api_name: qiskit.providers.aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.mdx index b6aedd18a7c..c2563e6715c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator # PulseSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.mdx index 98d63a8278f..c0c32538a9f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator # QasmSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.mdx index 3b31ce7ddc0..391e567364e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.mdx index a6368f4fce9..edd7c7f6db0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.mdx index bcf3fc8de85..bf090918535 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. @@ -96,7 +96,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx index 214906f5d28..dff9d23fcc5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix # SnapshotDensityMatrix - + Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") Snapshot instruction for density matrix method of Qasm simulator. @@ -93,7 +93,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx index 328c946c189..46191e3c202 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue # SnapshotExpectationValue - + Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") Snapshot instruction for supported methods of Qasm simulator. @@ -95,7 +95,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx index e464ba2bb25..62d0f5c15eb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities # SnapshotProbabilities - + Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") Snapshot instruction for all methods of Qasm simulator. @@ -94,7 +94,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx index f0e24950903..388686b9029 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer # SnapshotStabilizer - + Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") Snapshot instruction for stabilizer method of Qasm simulator. @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.mdx index a06bacc4cbe..cd512c91eb9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector # SnapshotStatevector - + Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") Snapshot instruction for statevector snapshot type @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector ### define\_snapshot\_register - + Defines qubits to snapshot for all snapshot methods diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.mdx index dfb99b2c1a6..f2d83d2ce44 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.mdx index 195eff0f3a3..09fcb3b769c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.mdx index 1a4dd229d3b..36f54c5a6c5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx index 9a3efa1f378..7e6cdba859c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.mdx index 2f06cc3d5ca..268c558fdce 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford # SaveClifford - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.mdx index c3b682c6900..9adc856bc07 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.mdx index 56c4b0e854e..9485b680173 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx index 3baa259ca23..77bb205a11c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.mdx index 80915610450..fd5bfc12b81 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.mdx index 5cd5b44dd3c..e3fba3a6668 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx index c86ea2ab0a9..bb9d3811ec0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.mdx index bb2bcb16ba5..76228758eeb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.mdx index 18195834c75..82b267693a5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveState # SaveState - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.mdx index f364124d276..1b0f8854361 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.mdx index d7dafeef6b1..2d016adbd8b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.mdx index 3c5db45756f..604bd292d92 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.mdx index bc085732fe4..4d66a8d4dd8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.mdx index 54d3b5b021f..54f1bbb109b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.mdx index 05ecf5e6ab7..c5fcaf23e28 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.mdx index 59b894c0da6..47c2dcac1e7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.mdx index 8679ecbcfe5..8b37659400a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.mdx index 442f0d7d3f2..da53a53f31d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.mdx index 6de33914ef1..be359700a02 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.mdx index cd6072194ec..0cd1d543e5b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.mdx index 8b88c6a127e..efde9625d3e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.mdx index 5cf8d7659ab..57008fc4fdc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -225,13 +225,13 @@ python_api_name: qiskit.providers.aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.mdx index 6a2f2f6f5df..afebd359507 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.mdx index f06253eb2a7..ca4d880485b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit.providers.aer.noise.LocalNoisePass "qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.mdx index b43821740f7..74ad7242f39 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.mdx index ac87d005db2..7c370cba755 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.mdx index bd9a7ce55e6..6d79209219d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.mdx index 3efdd8c583c..eb994db3560 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.mdx index 0fd5a2ac16e..692f4502ae1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 976c92dc418..cffdf57fe86 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 5eaa09907a8..572447eec3b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index cf48576b02b..b44186a5ef4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index e0bab8df768..6f9cd22889b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.mdx index 1561c9bc040..7176c4783c5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.mdx index d9873521ffc..57b2d03a6cc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index d4bbd4c5544..6da20ace583 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.mdx index e06aa05ebd2..1cdca5470b3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 8cf82f2519c..d65b6d0d5ef 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.mdx index 86b472806f3..c6cf2ae4dac 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.mdx index 99e2cbbc5d1..62386f81e08 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index fd1fb390260..a789f42129d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.mdx index 45717bbbc5c..233ff501efd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.mdx index d7b26ee190b..0ea392b0ce3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.mdx index dc87921dec9..21027dd6961 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.mdx index e5921844fcc..f89f84dd2bb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index 425bd826f55..2e3268b3322 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.mdx index 843f6d91e8d..92a5f13345c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.mdx index de4f2d78272..30b1281ed14 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.mdx index ca6aa5bda0f..eda9df19b6e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index 94ad6324618..da6643ff0b4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.mdx index 2fed8a488e9..d8ee11c88e5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 05c7c4c640c..194e410a229 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.mdx index 34065c325e0..ea156f72291 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.mdx index 64442bb13a1..4d211dcfbf8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.mdx index b5cc05417ff..c46f2e642a7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index afeec9043f0..465af02bd0e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.mdx index 635d8de2b54..b27ce6ecbbe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index f1721b6c05f..f66af725100 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.mdx index ac9ae598ef7..23fd1358ba0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.mdx index 1a0c7cc48ef..142eb8834ab 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 1faea7c435d..022d1faddd1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index a4b1e60c8af..0ee01f61e2d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.mdx index d59f8031654..fe021115c39 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 44798c6187a..a359b62ddf0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.mdx index 8add8c48187..5f46b4ad800 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 6a59808aa0d..883a4b6718b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.mdx index d90423300a3..12a20c69ec7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 9c6c46f094a..17bc35a1446 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.mdx index d396516c04a..322a9aba1e7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 9a987eb15f3..82aa746e1bb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.mdx index 258b8235566..4c6656698ae 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.mdx index 1cbd3a7e9d3..4da919665a3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.mdx index 2b4253f7cd8..7bbc9031acf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.mdx index d194e8c834f..d43b02fd471 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.mdx index 0719728318c..2d32525b2c8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.mdx index 39d24781816..fe4cd9535a8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.mdx index 3e5915bfcae..73f76d1a4aa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.mdx index fccd3af362c..7c66e8154cf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.mdx index 6728949d648..cc05cd10e41 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.mdx index 27bd3c641e3..f18d1708c8a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.mdx index be4e0c8e7cf..b93f410d62f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index a3ea27c80c5..7e360ee3623 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.mdx index 8a60edc6ed3..3d6c82578cc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 22f0ec0e94f..ccbd14624b5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.mdx index 029a292a399..954f864556e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 9931240add5..34fdbd785c4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index fbf9e34beef..553633094e1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.mdx index 7b086835bf2..6ffbef7f00b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 2fb3ff2087e..77555dfbd3e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 7efe13472a1..275f26ec1ef 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 12e9dd5c84b..e1bbeb19d88 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.mdx index 143371a3a8c..0bdda15ffd7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.mdx index f38712698bf..54f98d06258 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.mdx index 23c36bfdda5..670abd4ae30 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.mdx index 63ec924af29..a4956696341 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index a4a23c966c4..50c53d3cad0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index ba3859e3e4a..37769d340b0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.mdx index 4be07fb52e7..99512967988 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index bae54b2ac44..a01130909e0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index c0709effe2e..5fc983cceef 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.mdx index 750b4c82e49..0c9a99e2a09 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 8033443b677..3f4f0611e64 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.mdx index d243be891d4..3a59b17c610 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.mdx index e246fb5ea59..87b7d187c3f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.mdx index 238d5f666d6..57cc115423e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.mdx index 0a156b0f8d1..455321d1374 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 4b213196ec4..98b14bd3ac2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.mdx index 176093d3cf3..cebaf66bac2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index e01061e113f..cb31628c560 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.mdx index be8b49097bf..c3c1dd3ffdf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index d283d3a28c1..571bdcf6e32 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.mdx index 5b22a25e6ac..f8b731c2462 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.mdx index c5048411225..dce9b397264 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.mdx index 8d218a1325e..0e5e9534af8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.mdx index 0f2a0942c8f..48e15d54525 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.mdx index d27546d42da..e6c68b0047e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.mdx index 9f60a143a0e..9616bf417e9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.mdx index 43e5a07ade7..b82ee666459 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.mdx index 238d5da9d88..05add6bd4da 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.mdx index dca41e6cf16..32c41b92d18 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.mdx index 34d9d252950..ec42722f4bf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.mdx index 30af1da7488..bd4ccc963f5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 994951d074b..683e8fc362e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.mdx index 587b4f33a62..a3283ffb2bf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.mdx index 4c0b6de3cb2..15efd92c024 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.mdx index cdeddffde9e..45e75e4c938 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.mdx index 08978953371..c6066f6952d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 77938eed65f..b62debef98c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 08324f4c785..6c1891afb4a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5e1f36a1ef0..11591b97239 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7bd9846736e..086ef5c02f8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.mdx index 5ede14ab55c..021978045af 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index c59e5af9b43..365d96ca0c5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.mdx index 5f50a19aac8..24f30f00baa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.mdx index f8fd56fe3c9..4635a794f78 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index cfa5dc1a253..5d5279797c8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.mdx index 1025e5dab66..5e5087bfac5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.mdx index 2130a77110b..c7cae20bdd0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 467d2398c52..d5b0a4daf6a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.mdx index 0e1a378f9bd..d26ccb56456 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.mdx index 7e1548d1cb0..0202bc7b909 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.mdx index 4e66ec8b9a1..32c8d2d7dd4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.mdx index 100c51bcfd9..e92e302672c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.mdx index c4aa52f6b05..9ae4c8afb7c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 18cce35ed89..73a0f0e6ff5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 43ba66ed697..0d799ae020f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 0a14a917596..972837399a2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 6fb7ea75087..240333075ca 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 8eb4301abf2..44b546c722c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 644d3507432..73ae596305f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 3806bb8f5a8..167482f59ea 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index fd7a8cb6435..4fd6a4fd1e6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.mdx index cf73bb34b57..ee1c3c2481c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.mdx index df337b0a430..fc2f7094455 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 35a0cc6ba99..8f64345b896 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.mdx index 47dd3486da9..356a036be9a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a241f50de8a..95749d75f86 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 03fc1cf820d..bea5ed64106 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 7a9308801b9..39107919c9c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.mdx index d01acdace81..1206689f3a5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index ef785d44f30..3c5f7a79905 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 68fc1e67894..84038a821cb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 67ed3ea14c8..72c9835f3a7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 8003237ebc0..c16e4af1d0e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 09e5727ca8d..190201a49d0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 0dcb7a64379..bc551f07f60 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index de50c05e444..ceacc699e63 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.mdx index 5c6ec461157..b36b28522dc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index dc3f7694a16..92a276dd987 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.mdx index 550c58cb49d..ac70efe12e9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 6ad2d0dcc96..7cd34a69761 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 81c7ede59f6..797d9fbd982 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index d0ab183f707..4aa930eeccf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index a0adaecb07a..5b885f2d779 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e79f25b1745..d9be3834224 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 3959fb827aa..e891cf63722 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 0e4036b4bee..bdaf1e041b3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 526e10d5308..9b86a18a7cf 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 60fed36866c..25505c3be0a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 0f827e65be8..50d91643724 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.mdx index 065571e1ec1..5b0a654b348 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.mdx index e353576bc82..27fd820263b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.mdx index b68bf4d3631..219f00db105 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.Command.mdx index c82b0ae6d56..f9e6893a769 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.mdx index 7b9cb61e605..d2837bc7057 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.mdx index 83020318556..0de95a23664 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.mdx index 5bd47b1ce0c..76c29cc68de 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.mdx index 61306b3188b..2a9f3492838 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.mdx index 1989af586f7..c19ddcb3b32 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.mdx index 5de9ecc752a..149a33eca17 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.mdx index 27135c31aa7..0f826811d2a 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.37/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.37/qiskit.pulse.Schedule.mdx index cc836d326b0..b782ac32b5c 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.mdx index 0c0b48501d0..4dc02415716 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `alignment_context`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.mdx index 0fe80ba58db..a86afb3d18a 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.mdx index 69f29466b67..0f27fa8066c 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.mdx index 66e86a37d9b..78f1fbc5c5c 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.mdx index e8431e4d516..8a9b8109263 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.mdx index 0de5123d744..e9e9840505d 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.mdx index 8727c0ca3e1..690d59f8401 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.mdx index a4f6a932436..68293737f33 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.mdx index 11e6af1e5bb..184aeda1dbe 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.mdx index af7d6f49ffa..1205adba823 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.mdx index 3d17b6e2954..c80963fe199 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.mdx index 5b240e24b16..5a212f48e21 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.mdx index 985acdc77cc..ae155f0189d 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.mdx index fa8fbfd08c0..8741008a3a9 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.mdx index bf432fad2c2..23cbfb38db4 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.mdx index 39c48141cc7..87919b57062 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.mdx index 11620857c48..2adb9610829 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.mdx index c95d974f809..a6f32020611 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.mdx index f444433e5ef..077badc8af8 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.mdx index c4469793b06..c4182889709 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.mdx index f3288f28fa6..60b475545ca 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.mdx index a41bbf80b9a..332155e4a47 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.mdx index 6d39ae6a659..0c271d62113 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.mdx index b8894631d61..811ee2910f0 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.mdx index 2aa471bf229..9d42fcb2ac5 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.mdx index 2aecd02574e..ad746ceae5f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.mdx index e0a70423745..ed9630c3725 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.mdx index c5ec9546e0d..2d6749419c4 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.mdx index 5a49e2c26db..0604c0b3127 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.mdx index ad7fb85ba2a..bb503ec3e1a 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.37/qiskit.qasm.Qasm.mdx index 889d44fae13..63874edafa3 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.37/qiskit.qasm.QasmError.mdx index 88f91982f74..6ccca61a664 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.mdx index ef33063b0a1..200f3535b08 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.mdx index 3996518bf23..d25ca350f92 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.mdx b/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.mdx index 59c87223804..43fbbe6354d 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.mdx +++ b/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm3.Exporter # Exporter - + Bases: `object` QASM3 exporter main class. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.mdx index cc23b4d05ef..2f0fa31e709 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.mdx index e58bfb471fc..94c8987fdf1 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.mdx index 17609594460..c300c5740d8 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.mdx index 67707266aca..030575766b1 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.mdx index d299c62ae4b..dab4c19003b 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.mdx index 8560ce6c623..c55f4f17de8 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.mdx index 9fcb8711e93..5732fc19d63 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.mdx index 5b83d0fc3c0..ccd03504eb9 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.mdx index edecb88f8e1..142f8c84a01 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.mdx index 199b732e803..6eecd8c20f9 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.mdx index 8b02c0abe0a..0c48c88a677 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.mdx index 1252a2188e2..58115f5d3bb 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.mdx index b4341a92596..a4b02669e8c 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.37/qiskit.qobj.Qobj.mdx index 1840ca1357e..9d3ad17cc66 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.mdx index a3d5bcd2364..62532f50fa1 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.mdx index d9fdf7cf34c..4ee311d6025 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.mdx index 698c446e847..c9ecacc42b9 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.mdx index 03fbd022993..54f08a6909d 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.mdx index d13b94cf074..89ad2c88b9b 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.mdx index 6414f1d832b..8a91a91e5f2 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.mdx index 3fc2b198a78..5d6a98475d9 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.mdx index da87b76b4bd..93fadb314d2 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.mdx index 1be46c2dbb2..10d1d1b0876 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 5c3de65cbe7..724b5d0ee78 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.mdx index d8d729f03be..cc6d3df2d44 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a :class\`.QuantumCircuit\` While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -180,7 +180,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.mdx index eecdfdcad09..7f0ed98f95f 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.mdx index e3555349f6c..1c69f6218ad 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.mdx index 07df9b46a42..4d422ab09f9 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.mdx index 7b9fbca051b..95605154434 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.mdx index a0d79f1925a..c6a28ec1315 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.mdx index 7899019f29c..6e4b6b64d27 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.mdx index 2830339b93c..7eb96181490 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -176,7 +176,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -211,7 +211,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -237,7 +237,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -446,7 +446,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.mdx index cba3f15d4b5..474a4d86e16 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.mdx index bca170b2571..7bb81b1f156 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.mdx index b29cf4952d5..a6f737e6678 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.mdx index 204caa92663..214bcbda18e 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.mdx index 59c5d46284b..91b0de30604 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 2d531c306a6..3892fe3178b 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.mdx index f859c40ca51..fb6c7151831 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.mdx index 56985ebcf8e..dbbb1eb6ad4 100644 --- a/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.mdx index c00fd0cd2fb..ef6aa0e5dd2 100644 --- a/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.37/qiskit.result.Counts.mdx b/docs/api/qiskit/0.37/qiskit.result.Counts.mdx index 4d46630eee0..10ea4c8f094 100644 --- a/docs/api/qiskit/0.37/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.mdx index 5f85a6a6919..ce5ea9e1c9e 100644 --- a/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.mdx index 78ebd643054..b9712f618c8 100644 --- a/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.mdx index 01396eafbbd..86b8830003a 100644 --- a/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.37/qiskit.result.Result.mdx b/docs/api/qiskit/0.37/qiskit.result.Result.mdx index d765a17dc5a..d80b5f11e0a 100644 --- a/docs/api/qiskit/0.37/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.37/qiskit.result.ResultError.mdx index a301a3b3674..431e698e215 100644 --- a/docs/api/qiskit/0.37/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.37/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.mdx index cf8ada0a673..26d658cac6a 100644 --- a/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.mdx index aa66fb2b3fd..57b1d679b8e 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.mdx index ecf0663b5dc..7d887ca86e6 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.mdx index d8f7454c516..6b10d66cace 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.mdx index 796bfa030f9..491b4ac441b 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.mdx index b93ab62a1a3..1fe14f66a3d 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.mdx index f095b03efd1..2f2c6b6f5f6 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.mdx index a4b8e96fb73..99c99105a70 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.mdx index af46c393cee..24f188d99eb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.mdx index a37084010d6..8a97bc388ce 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.mdx index ac8f3f748e2..a4f221e4607 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.mdx index 566b97c97b7..f4312594740 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.mdx index 6462c4094d8..54eefce24c5 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.mdx index 6d29487aea7..477a150f0a8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.mdx index 5b9fb3d0664..1b729e056ae 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.Layout.mdx index 03299a6a14d..4cacd2012d0 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.mdx index 007d266f7cb..87172e348db 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.mdx index 0719da9b472..cada02de61e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.mdx index 4da1ebb6070..646c0c86327 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.mdx index 53f73913126..1bebf3653d7 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.Target.mdx index 5c901b14684..8489e86a737 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.mdx index 3169eff802d..fe698e36362 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.mdx index cd6458092d9..a790005f378 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.mdx index d2440214469..cc96a0fc43c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.mdx index 4b028a7d3df..ead7765f73f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 0a978826080..bb21f0dc23f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.mdx index 2b80fdeb6d5..bce44adf24d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 946a0b6d42a..684acc1f344 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.mdx index 71a519ca18e..35f1669ad6c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.mdx index f1fce10a450..6812675f27c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.mdx index ed4646abfa1..8534f4f53bb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 1c3a690030a..96c798b328f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.mdx index 85bc20416ee..0de77a46551 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.mdx index b61a070f7d5..59fb56bba82 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.mdx index e59439d570e..58dcdf59500 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.mdx index 7766ed6644f..376aad7a5ff 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.mdx index f13f59e89ab..0f52cc1ba4c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.mdx index 7d89b165959..02b40cf362d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.mdx index f8ae3228254..79fedc260fe 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.mdx index 3f15616d1d0..5a639bc9fec 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.mdx index 0f4d338d577..a286a3c0dba 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.mdx index ca2591e1281..5f5cb77e77d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 81c9ce2b689..045a47b0f7f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 4c32b6fdd5d..a234ac2b1fb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.mdx index 65753cad22e..05650bfa09a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.mdx index cbc0d6a7269..9210fd870a2 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index c5f504c808f..e4bcc263ff5 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 3b2c1f56408..aa722812fc6 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 3bc39a4bad3..c388e306411 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.mdx index d4c1dd772f7..13a6678c298 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.mdx index 9742bf60a22..d02596a7753 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 7eae4450236..e27c7120a2b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 397adb85e92..55dcd9f1873 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.mdx index 1757d1ba90b..aa80df92683 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.mdx index b7b8f4c76e6..0b565cda4c4 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.mdx index 1ca5c6e70a1..efc4dcdf72e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.mdx index 3af8045fb54..e869adbf851 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.mdx index b0083e50d32..835e6febb33 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 8efe8e0e4e7..61ab56f6a91 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 5a620067f10..dd4bd5e1718 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e7bdec967fa..e50ef252951 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.mdx index a9f8695e40b..51576562373 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 6a996622512..5e3ef1d7255 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.mdx index 24b34782a6c..c9b0d9d10ad 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.mdx index e7b67ffcdcb..cb2f1ac71d7 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.mdx index b0c3277668f..c92f073723b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.mdx index c4a43a9291e..c7756ce6e44 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.mdx index 73ebaa2b441..312971d3691 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.mdx index 65bc4c51979..b1aaee5b0f5 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 94a866eba97..54e61591b9b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize linear functions. Under the hood, this runs cnot\_synth which implements the Patel–Markov–Hayes algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 1724cd21f0e..d885df08864 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.mdx index 9db4b4540c9..ad262c915d2 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index a2563e85d7e..f4040c9b530 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 4e974340ad5..e1de0951429 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.mdx index b1edb981971..08f874e79e8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.mdx index b7934c88c7b..b437f7a15b8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index a1acd4d7081..82b50ed4eab 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 876c5468b20..9fa1d474812 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.mdx index 47c5965b11a..62fc6fad457 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index b98b6440a2a..8ab94627526 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.mdx index 8d745c8035f..e9750928b79 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index a7c94394d93..cebc4254038 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index a8b3e1ab1c6..01256d7b2f8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.mdx index 2d5291422e6..72ffc72a362 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index b7a82fa96fd..4bcb1372b4d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 67fb37c0e33..26ceb371296 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 813318b2a0f..fb9476ca2e9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.mdx index da98f233774..97db8175439 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.mdx index dfefd7ae347..e76f51e8cc6 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.mdx index 0121ebebe55..20268d4a707 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.mdx index aac40dcb06d..2849586e49f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.mdx index 74f991c39b6..39058c48f11 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.mdx index b270b6c2c27..542c59a9ddd 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.mdx index 985c1157222..ae7eaadfbc9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.mdx index 74261e31b77..98adabb851a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.mdx index 3b2bc88638e..4cca8ee2d60 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.mdx index 71cc2faf995..aafa5fbae49 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f6719c7ae51..94f89841052 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 0c0cf7e2b6e..32f90fb0916 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.mdx index 6b3c755256e..0c5c791841e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.mdx index e7b664bf316..d743417c511 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.mdx index 9586e35afa5..e78da8d7457 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.mdx index 038ac1618c2..41392258dd2 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.mdx index 8a0f120a759..20d3f82d95c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 2baabd1ea3d..fc5ece7ea83 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index f13a1e59adf..cd0f5a117a3 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.mdx index 99979593fe2..5eb0278be4e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 26917e48514..9b6e97d19fa 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 3eb3a880f34..b7a3b44c8ff 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index d037894071d..27ba4a689ae 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 3f2f65d3437..d8571fdca0d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 33176c37501..dbf72c6ae00 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index ec69e448ad8..ec5b51748fe 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.mdx index 3b99584d10b..ef4bbd3c07b 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 35c1a30a9ac..8a82fc675c6 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.mdx index a3c2495d891..50f67e83d18 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.mdx index ad9285e0149..c665f349d3f 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 867487577e2..521767651e0 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.mdx index f1f0b007658..d795eaef352 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.mdx index aff3b79afcc..aa0f38bce70 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.mdx index c8e966e4648..3ae5b8d29f4 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.37/utils.mdx b/docs/api/qiskit/0.37/utils.mdx index 1378aa93901..8c47e7f72d9 100644 --- a/docs/api/qiskit/0.37/utils.mdx +++ b/docs/api/qiskit/0.37/utils.mdx @@ -109,7 +109,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -149,7 +149,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -216,7 +216,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -230,7 +230,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.38/pulse.mdx b/docs/api/qiskit/0.38/pulse.mdx index 55e77c9823d..7ad78af8675 100644 --- a/docs/api/qiskit/0.38/pulse.mdx +++ b/docs/api/qiskit/0.38/pulse.mdx @@ -66,7 +66,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -226,7 +226,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -668,7 +668,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.mdx index 6ff1019c8bd..e795f0f9431 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.mdx index 2a4e07527b2..03a9fff237e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.mdx index 3173c341c90..0a40c9b69a6 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.mdx index 23928894164..cf73d7c5075 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -48,7 +48,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -73,7 +73,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.mdx index 3068ef4d09c..37d965aa0f8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.mdx index 90d8d7f8dc2..9f2042378d9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 6d3271fa435..6e4503b2bf8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.mdx index 569fb27825a..2e2d419c16f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` The Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.mdx index ac261ba61af..5fdc7348a23 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver Result. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.mdx index 97ab8615264..d886a239016 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.mdx index fe5beb8ef82..23ea8af8cc9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Evolution problem class. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.mdx index 7c73b11fb2b..c571cb4591a 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding evolution result. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.mdx index af534df3896..b998c31c97d 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index b4222fb9421..8fdaf612623 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.Grover.mdx index f60e272cfce..3ea10cd5b4d 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -135,7 +135,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.mdx index c7c4b5dbe99..14d4e83676d 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index e651d910d3d..e2c1842dd81 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 282bcb9d417..da5fe41e64b 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.mdx index 52a82c4c162..cc43b7f63a4 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index e9bf1c02b21..22baefe6604 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 5503b197356..27939b97bc7 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.mdx index 5bed0f86fc7..c1ff86b4939 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 366eb97a052..8bd59c5167f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index d10bfe48bcb..858183b8e89 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.mdx index efecd6ad63e..10365c08f01 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.mdx index 3edc5f41ed3..4643c430ab7 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.mdx index fd8af2bea39..ad2cf9f3ab4 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") The NumPy Eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.mdx index bb67a3ae297..3fdb36b72c0 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") The Numpy Minimum Eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.mdx index 0edec4f5d47..52a7d1e7408 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.mdx index 87d5020d2be..f179c5d26b9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.mdx index b182534ed9b..6b70bf75a63 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.mdx index 992e1c13d88..367a1adc469 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") The Quantum Approximate Optimization Algorithm. @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.mdx index b4223cca0b0..65fd9d8ed41 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.Shor.mdx index 7ec301e1475..c47cb76765b 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` Shor’s factoring algorithm. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.mdx index 34815eb4625..064fcd5ed5e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Shor Result. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.mdx index be9f2f1d9a9..ba13f3ee123 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a ProductFormula provided. @@ -69,7 +69,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.VQD.mdx index 21232114e70..dd3768996d3 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") The Variational Quantum Deflation algorithm. @@ -146,7 +146,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.VQE.mdx index 02114ce0613..83f9ae574f5 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") The Variational Quantum Eigensolver algorithm. @@ -171,7 +171,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index cb60cbca0ef..35f63dd1fc1 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") An observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.mdx index e9dff5d46ca..f53e3b018d9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.mdx index 0396f6cd857..0942f8c8c05 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` An abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index b37483302df..df6455a9af2 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` A base class for linear systems results. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index 1dff622298c..0b620424f8f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for linear system matrices. @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -344,7 +344,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -354,7 +354,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -471,7 +471,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1076,7 +1076,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1218,7 +1218,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1236,7 +1236,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -2051,7 +2051,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 74aafe842d8..4954dab4cb5 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` An abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 3f27843d1d6..bfe8c2447ba 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") A class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index a39702595fd..3a8610a5fd5 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index 295156cc04f..fca0daab82e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") Class of matrices given as a numpy array. @@ -281,7 +281,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -367,7 +367,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1241,7 +1241,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1259,7 +1259,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 710b0535138..7f78518537d 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") Class of tridiagonal Toeplitz symmetric matrices. @@ -294,7 +294,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -380,7 +380,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -390,7 +390,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1254,7 +1254,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1272,7 +1272,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.mdx index 25c364fb8d2..3cdb05f1a88 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.mdx index 62b547f2577..6dcb27357c8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.mdx index f9e5352b4c7..71f74566eb2 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.mdx index 1fb4bc46964..37777d7fae7 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.mdx index 2cb197aeb5a..95a048fbfef 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.mdx index a547c88e2f5..ae7b8f59373 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.mdx index 721c1e8a4b5..4283a6c6124 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index edf189e1af1..12cf7b16da2 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.mdx index 03bf9b91c2e..0fb99f3790f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.mdx index 7bec24640f1..f5bf3f0bd80 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.mdx index 29e891170b9..a590dc4d3c4 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") The gradient descent minimization routine. @@ -96,7 +96,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -162,7 +162,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.mdx index 734ac7cdfd4..ba636a21cda 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.mdx index 3c173dca901..319dc9c1d7e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.mdx index cf27300f1c4..8486d535b90 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.mdx index a2de0104b9c..547293e80f5 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index df580b9a606..47dbca48603 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx index 4e47394cf11..f36be0910a1 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.mdx index 1e86e3520c3..859e20a7c49 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.mdx index 4d1c5a537b8..beca98fc266 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 1c1c4e62de2..677b656c6e0 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.mdx index 1e239a97e77..bf844ffcd18 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.mdx index b9411efa192..3f2d38c3cbd 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.mdx index aea99b49bd0..8326313a76c 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -106,7 +106,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -116,7 +116,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate @@ -150,7 +150,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -240,7 +240,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.mdx index 8937647e0c0..7f45827dbd9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.mdx index 8c4291da8a5..69ce727a493 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.mdx index 1ca19e5f133..1d9ec4b91ca 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 01ec99bf809..85709ca51e9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.mdx index a3de83d4271..2f198b95662 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.mdx index 74311450bf6..2d5de27a9c4 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.mdx index 0ce7289f857..ca515072fdb 100644 --- a/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.mdx index 44550b18dba..38f1580ba9b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.mdx index 42030cf3b85..89ed7c78f75 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.mdx index 961ab342e9e..7c66f93e5b2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.mdx index 8a921b87da0..5f05c917c88 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.mdx index 4d5f6e82e33..6143dc8886c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Clbit.mdx index c437db05e23..e2c35437972 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.mdx index 7c83e27b2c5..bc1f62622f8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.mdx index 56ec7965e6e..6f98c6c6b41 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.mdx index 3dd8a4890f9..64149632845 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Delay.mdx index e4d7d691e87..ef29c18900a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.mdx index 6072eb65edf..34db4f912d4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.mdx index 5b2cd1ead1e..48211691d10 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Gate.mdx index 5ff1195efff..52608ac79dc 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.mdx index 648450f758d..5212314fcbf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Instruction.mdx index 7f0de20fe86..432d10c5c9d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: `object` Generic quantum instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.mdx index 8ab61751a64..29508043bff 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Parameter.mdx index b8ee23413ba..6713ffa2237 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.mdx index 4feccaa263f..e43d7bbd435 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.mdx index 41eeaa269b7..ad67c2c8746 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.mdx index 74ec9e1cb6e..4d36370c0a1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -356,7 +356,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -442,7 +442,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -452,7 +452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1296,7 +1296,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1314,7 +1314,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.mdx index 3c09580999e..a5a24b0c872 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.38/qiskit.circuit.Qubit.mdx index 444ec89fe81..f7afc349919 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.mdx index 21dd44bd601..2867a470667 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 82d0397a8c0..a9a3711b86d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index c93b7e93040..1f9a9f273b3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 7901384e04a..c95cb7b0a5b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index bbdf5a84a13..fb49f4f1c3a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.AND.mdx index ffd95f22dd7..5b4f6deb39d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.mdx index d22bdfd8982..73afb0efc09 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.mdx index f25bcb78fd8..6e24e85a5f2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.mdx index 607c891c4c4..1eae722b619 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.mdx index 01674031ad4..f0298e869d8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.mdx index 9b40dcee39d..46281475037 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 8cff5bdd8b6..35875cd22f3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.mdx index dad09671a05..164f222f852 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.mdx index e1661ae948c..e457682e978 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.mdx index 62836e3d7d8..2d5e34ca568 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.mdx index 77dfce287da..604ad4b8d73 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.mdx index a3b8b055df8..4be458e9023 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.mdx index 6742eb7ac82..64de53b9fa7 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.mdx index 0192f18372a..b3b70e9508e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.mdx index 714e4ba3907..2cd80481a63 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.mdx index 3f52516cc2c..55eee83a0d8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.mdx index 3570d12b8f6..b4ac44ff61e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.mdx index 3cdb8d3c75d..03687969b7f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.mdx index 01ef9c56f66..fb60d32f186 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.mdx index 395919b0fd4..89686d1d9b4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.mdx index 1513b02b8aa..f6f394b9bc2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.mdx index 419b91c3715..30b9c7eb60f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.mdx index 04a090a9bda..6e681cb5e0e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.mdx index 513b305bf43..b3cd6db247f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.mdx index 2695e1aa906..531853ae921 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 2c12e23da1c..2d1195ceef0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.mdx index 1f747a87ac9..e6f162ab576 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.mdx index a4b41d277c7..015a8a3ad8e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.mdx index 966a4302a6d..bd3cef23c32 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.mdx index 8fcf1c60206..98da8bb0db4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.mdx index 36d3094116f..46969f1592b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GR.mdx index b8a68146b72..4d8832b9ecb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.mdx index b4fa265b4f7..8122305c5a8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.mdx index 8edabb40521..a5190fc1abd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.mdx index 114940e1f70..3724424efcf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.mdx index c3d9a041f48..7bcf779e380 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.mdx index 3c06b458487..2b1969a8561 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.mdx index afc39b53506..fbda07fa2fc 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index e6c3b23de0c..237f497c4cf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.mdx index 4f72db839d1..99f24baae31 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.mdx index 27d4092e304..4a93a1532a9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.mdx index f1e6e6a58d1..e11f4db231a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.mdx index d61538b27e6..1cffeaaa02f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.mdx index 32940f139bb..a00e85c1bcd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 616963c4ebe..8ad3960845a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.mdx index ae192f92e8f..ce16735e7e2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.mdx index 0d72dd4d561..b97fb88de4a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.mdx index 5a4c276f369..35dbb9aa136 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.mdx index 84d5fa9c04b..bc1981bbb9c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.mdx index a368814c862..e983bd4da1c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.mdx index 2c6c154fcd3..8b95caefc67 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.mdx index 7d21e15e3a5..0cda3d6019f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.mdx index 2f52fc2c36a..8ff1df12489 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.mdx index 25d11ba0678..72a788e4833 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.mdx index 4e80b724962..eeb254fc5b9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.mdx index e6516af58e9..d6fd835e33f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.mdx index 2821a5f2b13..292215d6f17 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.OR.mdx index 1e9425ec7ff..23cbcfbc5c5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.mdx index 03b48179f13..5aa142f7fd3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.mdx index 91593ba7055..7a63f367ec6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.mdx index acc63d00660..617a6d42640 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.mdx index d9d4e2e1e1f..122595ea074 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.mdx index f650328dac8..8d819cc5b9b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.mdx index 129f676c707..adba12efbab 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.mdx index 60d1de637de..523f6b66cde 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.mdx index 98d5402ad71..71cdf6acd91 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.mdx index ec8b67018ae..c71d21f769c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index d77145b41d1..e973ce86e53 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 719cb5cc963..8032e35234f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.mdx index ddcf910f594..99093a47df1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.mdx index 75ef5e5c276..18cf1440bfa 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.mdx index a211d581338..98b850accaa 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.mdx index a7f8d68c521..4ad3e99c9e4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.mdx index 83a63d23928..b127e9345b2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.mdx index 7aeb4e5e52e..b81595f36f5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.mdx index 15ed3963d97..2394de6ef9d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.mdx index 95cc1a82b8f..8101053e278 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.mdx index 611b0d0152d..ca1e07e896c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.mdx index fa649c62988..193342e6565 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.mdx index 0462a0b883b..3e2109c817b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.mdx index e22fb2e5232..2b02594684b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.mdx index aac75e94233..ca87cd7b600 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.mdx index 172982abecc..900698476cd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.mdx index 24b84ec0998..7cefceb79e1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.mdx index a23ced892c1..f71b5c700f3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.mdx index 350a5e1690b..15903be94eb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.mdx index a346d8a3a39..895d607a5bc 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.mdx index a45cf9ded1c..c934bde1a52 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.mdx index 6bee625042b..a66e36ad06d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.mdx index aa24fd4aed0..8cc5f225078 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.mdx index bd5f303bc49..a83831cff12 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.mdx index 384d7a1410d..862b538429c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.mdx index 90452c7f355..dff286e77d1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.mdx index c139e3fa28d..d645199a669 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.mdx index 50e35fb6171..53ab8a63d73 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.mdx index d83513aa490..dec0262faa8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.mdx index 4a73265ca33..2630b4c5453 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.mdx index 77d2383f08d..0d481d024b8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.mdx index d6b02d807a6..a7b09c17520 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.mdx index 5886ed1d9c2..1db5f1e1ac3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.mdx index 04d7d56c426..9b304eaa0fb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.mdx index c622cd6125d..277f9770a77 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.mdx index 5fdc95de6d0..b82bcff72aa 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.mdx index a2c4e8dd54c..a7cc75b46a6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.mdx index 8cf042df3eb..7584bdda00f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.mdx index 3b2eb07f3a5..be4ee1cbfdf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.mdx index 3771a0136ae..b45dfb39171 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.mdx index 1871f83b962..4850964b9ce 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.mdx index 4728de84985..b71418ef542 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.mdx index fce1eee772e..cd1e8546fc9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.mdx index b707f0e9490..da892e20108 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.mdx index 6de709c68d6..23cdcfd4002 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.mdx index af715f15111..404dbd83b01 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -269,7 +269,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.mdx index 4e2fbb1dcf4..a03417b344e 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.mdx index 06510850d1b..686e254e295 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.mdx index 4f4063b63d2..f2d29ea6012 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.mdx index bade0f5325e..db3a9274e42 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.mdx index 720b0feae9b..66dda14f456 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.mdx index 1daa2325563..190be183c57 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.mdx index 0dbd8829da3..c39eb7d4a08 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.mdx index eb63178a944..1fe749979c5 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.38/qiskit.extensions.Initialize.mdx index 88f2ac8ace3..8ffbe55ad8e 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.mdx index b870d9c959b..9f41b816f47 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.mdx index b8bb383ad44..9841376c7d0 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.mdx index a15edcccd95..c432e864d9f 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.mdx index cd4595ed2da..f3a3f74c2f5 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.mdx index a02e63ef0fc..8fff3d7465b 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.mdx index e358cabe5a9..c65b5b85f34 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.mdx index f288506d176..6eb11f93f9b 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.mdx index 71e34e36445..a9c61f51a12 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.mdx index b35417007c7..c37f2dc6e8c 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.mdx index 4407c70f6fa..98043c28130 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.mdx index da11dd99e2e..71d90b1bd28 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.mdx index 57c8fdc75b3..2bb47d6d231 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.mdx index a2067758210..b516756c9c9 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.mdx index 293cc31e547..f270bc65a3c 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.mdx index f2ae54ea14a..13635f66f0b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.mdx index 2088a7e673d..12867dc71d9 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.mdx index 04d1eb0a986..56218795dc0 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.mdx index 288d02baedc..9b0d8443b57 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.mdx index 606adf9a69d..2b038020fca 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index ef1dfdcc201..fe39da83420 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.mdx index 76d99b03c73..1853e99b554 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.mdx index 24b85a8e04d..a425253e89e 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.mdx index 845ce5a383c..f7c3f28d42f 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.mdx index 11afac9ba91..a9535bc015a 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.mdx index efec9c93168..bb778c91b65 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.mdx index bffb9227216..be7774e8b64 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.mdx index 1d48fb7f1ff..b1e75d1b015 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.mdx index 87f3fea5b6d..2699024abb1 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.mdx index d8253c4b265..3b574956a04 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.mdx index 1a91ff802e5..f0aa4c6b8f1 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.mdx index a298c32185e..12fbe7006c4 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.mdx index 9f88287d773..a343d69ba6b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.mdx index d4ea3fab205..ed5cdab575c 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.mdx index 14d418e9f68..fd2731b2911 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.mdx index 4d8cbef3554..8f02c7a76be 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.mdx index bb03015b29e..347de2a9e4f 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.mdx index bdbe0660857..cd94f735354 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.mdx index 88cdc0674ce..57c1a69345e 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.mdx index 22fdf62b89b..7028b0b71ac 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.mdx index d42c0a9dae0..5f6736212a8 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.mdx index 09761634a9b..c5435cb58b4 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.mdx index 6e5fd1342a3..cf502cbe72c 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.mdx index 5cbf508e170..77776384b91 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.mdx index 6544f395b21..ec8420798ac 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.mdx index d29856fb8fc..5411d370673 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.mdx index ef1311f7a09..52a738dc7cf 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.mdx index e5cf2d15bef..3d15db94029 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.mdx index de0bbc766c9..1099c8ff01b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.mdx index c494c57758e..b34ed35917b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index ccf7faa5ffc..6d9027413a7 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 6a5fc495fb7..24fc4d49ed6 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index bbc6aab12cb..2e6e82de4c9 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.mdx index d0afde61829..0e20176f22c 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.mdx index 8b1b381ba54..67c675ef5bf 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.mdx index fc920789b95..d2317afe605 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.mdx index d646ac12691..67b933c2ec3 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index ade1d34e002..afaa0392ce7 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.mdx index 12f05fa531d..fc9c932c8c2 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.mdx index 6e18ad4aad5..27bf9aa0b36 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.mdx index 49fdaba8fd3..fc397db424a 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `abc.ABC` Estimator base class. @@ -31,7 +31,7 @@ python_api_name: qiskit.primitives.BaseEstimator ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.mdx index cbb40c8d714..a91aac6bbc0 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `abc.ABC` Sampler base class @@ -28,7 +28,7 @@ python_api_name: qiskit.primitives.BaseSampler ### close - + Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.38/qiskit.primitives.Estimator.mdx index 01536255ed5..b4e86405dd6 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") Estimator class diff --git a/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.mdx index 140cc8cf039..b86c0ffac7e 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `object` Result of Estimator. diff --git a/docs/api/qiskit/0.38/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.38/qiskit.primitives.Sampler.mdx index 7e38f71dfc0..00a4c3079ab 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") Sampler class diff --git a/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.mdx index 7493f4fd427..2c104753857 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `object` Result of Sampler. diff --git a/docs/api/qiskit/0.38/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.38/qiskit.providers.Backend.mdx index 3f37e941bf4..7598dbf54e3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.mdx index 84e22faaa3c..b09f2d6e2a0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.38/qiskit.providers.BackendV1.mdx index dde4fb9634e..258314c26fa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.BackendV2.mdx index 27ab0433917..798edfc5d5a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -148,7 +148,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.38/qiskit.providers.Job.mdx b/docs/api/qiskit/0.38/qiskit.providers.Job.mdx index 67ec05826cd..f9d652d0816 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.38/qiskit.providers.JobError.mdx index fb05309a325..c555061b2fa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.38/qiskit.providers.JobStatus.mdx index ba74521d091..ebc4e347689 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.mdx index 19cf3498d1d..6d7b7af353f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.38/qiskit.providers.JobV1.mdx index f3ede6e3989..428804e60f8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.38/qiskit.providers.Options.mdx b/docs/api/qiskit/0.38/qiskit.providers.Options.mdx index d6545475929..9730eae3a9c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.38/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.38/qiskit.providers.Provider.mdx index 41e8845a9bf..a549bb466ea 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.mdx index 20b08c6a234..10c02c54053 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.mdx index 01c2ac4d005..0d2859e631a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.mdx index 47c0bf6c0b3..f4b6315440e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.mdx index bd9a7ce55e6..6d79209219d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.mdx index 3efdd8c583c..eb994db3560 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.mdx index 0fd5a2ac16e..692f4502ae1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 976c92dc418..cffdf57fe86 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 5eaa09907a8..572447eec3b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index cf48576b02b..b44186a5ef4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index e0bab8df768..6f9cd22889b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.mdx index 1561c9bc040..7176c4783c5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.mdx index d9873521ffc..57b2d03a6cc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index d4bbd4c5544..6da20ace583 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.mdx index e06aa05ebd2..1cdca5470b3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 8cf82f2519c..d65b6d0d5ef 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.mdx index 86b472806f3..c6cf2ae4dac 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.mdx index 99e2cbbc5d1..62386f81e08 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index fd1fb390260..a789f42129d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.mdx index 45717bbbc5c..233ff501efd 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.mdx index d7b26ee190b..0ea392b0ce3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.mdx index dc87921dec9..21027dd6961 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.mdx index e5921844fcc..f89f84dd2bb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index 425bd826f55..2e3268b3322 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.mdx index 843f6d91e8d..92a5f13345c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.mdx index de4f2d78272..30b1281ed14 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.mdx index ca6aa5bda0f..eda9df19b6e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index 94ad6324618..da6643ff0b4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.mdx index 2fed8a488e9..d8ee11c88e5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 05c7c4c640c..194e410a229 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.mdx index 34065c325e0..ea156f72291 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.mdx index 64442bb13a1..4d211dcfbf8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.mdx index b5cc05417ff..c46f2e642a7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index afeec9043f0..465af02bd0e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.mdx index 635d8de2b54..b27ce6ecbbe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index f1721b6c05f..f66af725100 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.mdx index ac9ae598ef7..23fd1358ba0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.mdx index 1a0c7cc48ef..142eb8834ab 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 1faea7c435d..022d1faddd1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index a4b1e60c8af..0ee01f61e2d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.mdx index d59f8031654..fe021115c39 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 44798c6187a..a359b62ddf0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.mdx index 8add8c48187..5f46b4ad800 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 6a59808aa0d..883a4b6718b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.mdx index d90423300a3..12a20c69ec7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 9c6c46f094a..17bc35a1446 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.mdx index d396516c04a..322a9aba1e7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 9a987eb15f3..82aa746e1bb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.mdx index 258b8235566..4c6656698ae 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.mdx index 1cbd3a7e9d3..4da919665a3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.mdx index 2b4253f7cd8..7bbc9031acf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.mdx index d194e8c834f..d43b02fd471 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.mdx index 0719728318c..2d32525b2c8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.mdx index 39d24781816..fe4cd9535a8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.mdx index 3e5915bfcae..73f76d1a4aa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.mdx index fccd3af362c..7c66e8154cf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.mdx index 6728949d648..cc05cd10e41 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.mdx index 27bd3c641e3..f18d1708c8a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.mdx index be4e0c8e7cf..b93f410d62f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index a3ea27c80c5..7e360ee3623 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.mdx index 8a60edc6ed3..3d6c82578cc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 22f0ec0e94f..ccbd14624b5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.mdx index 029a292a399..954f864556e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 9931240add5..34fdbd785c4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index fbf9e34beef..553633094e1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.mdx index 7b086835bf2..6ffbef7f00b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 2fb3ff2087e..77555dfbd3e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 7efe13472a1..275f26ec1ef 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 12e9dd5c84b..e1bbeb19d88 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.mdx index 143371a3a8c..0bdda15ffd7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.mdx index f38712698bf..54f98d06258 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.mdx index 23c36bfdda5..670abd4ae30 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.mdx index 63ec924af29..a4956696341 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index a4a23c966c4..50c53d3cad0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index ba3859e3e4a..37769d340b0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.mdx index 4be07fb52e7..99512967988 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index bae54b2ac44..a01130909e0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index c0709effe2e..5fc983cceef 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.mdx index 750b4c82e49..0c9a99e2a09 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 8033443b677..3f4f0611e64 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.mdx index d243be891d4..3a59b17c610 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.mdx index e246fb5ea59..87b7d187c3f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.mdx index 238d5f666d6..57cc115423e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.mdx index 0a156b0f8d1..455321d1374 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 4b213196ec4..98b14bd3ac2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.mdx index 176093d3cf3..cebaf66bac2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index e01061e113f..cb31628c560 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.mdx index be8b49097bf..c3c1dd3ffdf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index d283d3a28c1..571bdcf6e32 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.mdx index 5b22a25e6ac..f8b731c2462 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.mdx index c5048411225..dce9b397264 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.mdx index 8d218a1325e..0e5e9534af8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.mdx index 0f2a0942c8f..48e15d54525 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.mdx index d27546d42da..e6c68b0047e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.mdx index 9f60a143a0e..9616bf417e9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.mdx index 43e5a07ade7..b82ee666459 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.mdx index 238d5da9d88..05add6bd4da 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.mdx index dca41e6cf16..32c41b92d18 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.mdx index 34d9d252950..ec42722f4bf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.mdx index 30af1da7488..bd4ccc963f5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 994951d074b..683e8fc362e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.mdx index 587b4f33a62..a3283ffb2bf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.mdx index 4c0b6de3cb2..15efd92c024 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.mdx index cdeddffde9e..45e75e4c938 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.mdx index 08978953371..c6066f6952d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 77938eed65f..b62debef98c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 08324f4c785..6c1891afb4a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5e1f36a1ef0..11591b97239 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7bd9846736e..086ef5c02f8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.mdx index 5ede14ab55c..021978045af 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index c59e5af9b43..365d96ca0c5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.mdx index 5f50a19aac8..24f30f00baa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.mdx index f8fd56fe3c9..4635a794f78 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index cfa5dc1a253..5d5279797c8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.mdx index 1025e5dab66..5e5087bfac5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.mdx index 2130a77110b..c7cae20bdd0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 467d2398c52..d5b0a4daf6a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.mdx index 0e1a378f9bd..d26ccb56456 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.mdx index 7e1548d1cb0..0202bc7b909 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.mdx index 4e66ec8b9a1..32c8d2d7dd4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.mdx index 100c51bcfd9..e92e302672c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.mdx index c4aa52f6b05..9ae4c8afb7c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 18cce35ed89..73a0f0e6ff5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 43ba66ed697..0d799ae020f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 0a14a917596..972837399a2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 6fb7ea75087..240333075ca 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 8eb4301abf2..44b546c722c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 644d3507432..73ae596305f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 3806bb8f5a8..167482f59ea 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index fd7a8cb6435..4fd6a4fd1e6 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.mdx index cf73bb34b57..ee1c3c2481c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.mdx index df337b0a430..fc2f7094455 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 35a0cc6ba99..8f64345b896 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.mdx index 47dd3486da9..356a036be9a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a241f50de8a..95749d75f86 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 03fc1cf820d..bea5ed64106 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 7a9308801b9..39107919c9c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.mdx index d01acdace81..1206689f3a5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index ef785d44f30..3c5f7a79905 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 68fc1e67894..84038a821cb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 67ed3ea14c8..72c9835f3a7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 8003237ebc0..c16e4af1d0e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 09e5727ca8d..190201a49d0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 0dcb7a64379..bc551f07f60 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index de50c05e444..ceacc699e63 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.mdx index 5c6ec461157..b36b28522dc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index dc3f7694a16..92a276dd987 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.mdx index 550c58cb49d..ac70efe12e9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 6ad2d0dcc96..7cd34a69761 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 81c7ede59f6..797d9fbd982 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index d0ab183f707..4aa930eeccf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index a0adaecb07a..5b885f2d779 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e79f25b1745..d9be3834224 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 3959fb827aa..e891cf63722 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 0e4036b4bee..bdaf1e041b3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 526e10d5308..9b86a18a7cf 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 60fed36866c..25505c3be0a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 0f827e65be8..50d91643724 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.mdx index 065571e1ec1..5b0a654b348 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.mdx index e353576bc82..27fd820263b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.mdx index b68bf4d3631..219f00db105 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.Command.mdx index c82b0ae6d56..f9e6893a769 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.mdx index 7b9cb61e605..d2837bc7057 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.mdx index 83020318556..0de95a23664 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.mdx index 5bd47b1ce0c..76c29cc68de 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.mdx index 61306b3188b..2a9f3492838 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.mdx index 1989af586f7..c19ddcb3b32 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.mdx index 5de9ecc752a..149a33eca17 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.mdx index 27135c31aa7..0f826811d2a 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.38/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.38/qiskit.pulse.Schedule.mdx index cc836d326b0..b782ac32b5c 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.mdx index 0c0b48501d0..4dc02415716 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `alignment_context`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. @@ -239,7 +239,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.mdx index 0fe80ba58db..a86afb3d18a 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.mdx index 69f29466b67..0f27fa8066c 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.mdx index 66e86a37d9b..78f1fbc5c5c 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.mdx index e8431e4d516..8a9b8109263 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.mdx index 0de5123d744..e9e9840505d 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.mdx index 8727c0ca3e1..690d59f8401 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.mdx index a4f6a932436..68293737f33 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.mdx index 11e6af1e5bb..184aeda1dbe 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.mdx index af7d6f49ffa..1205adba823 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.mdx index 3d17b6e2954..c80963fe199 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.mdx index 5b240e24b16..5a212f48e21 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.mdx index 985acdc77cc..ae155f0189d 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.mdx index fa8fbfd08c0..8741008a3a9 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.mdx index bf432fad2c2..23cbfb38db4 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.mdx index 39c48141cc7..87919b57062 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.mdx index 11620857c48..2adb9610829 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.mdx index c95d974f809..a6f32020611 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.mdx index f444433e5ef..077badc8af8 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.mdx index c4469793b06..c4182889709 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.mdx index f3288f28fa6..60b475545ca 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.mdx index a41bbf80b9a..332155e4a47 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.mdx index 560991f63c7..d4ad82de370 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.mdx index b8894631d61..811ee2910f0 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.mdx index 2aa471bf229..9d42fcb2ac5 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.mdx index 2aecd02574e..ad746ceae5f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.mdx index e0a70423745..ed9630c3725 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.mdx index c5ec9546e0d..2d6749419c4 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.mdx index 5a49e2c26db..0604c0b3127 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.mdx index ad7fb85ba2a..bb503ec3e1a 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.38/qiskit.qasm.Qasm.mdx index 889d44fae13..63874edafa3 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.38/qiskit.qasm.QasmError.mdx index 88f91982f74..6ccca61a664 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.mdx index ef33063b0a1..200f3535b08 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.mdx index 3996518bf23..d25ca350f92 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.mdx b/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.mdx index 59c87223804..43fbbe6354d 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.mdx +++ b/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm3.Exporter # Exporter - + Bases: `object` QASM3 exporter main class. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.mdx index cc23b4d05ef..2f0fa31e709 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.mdx index e58bfb471fc..94c8987fdf1 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.mdx index 17609594460..c300c5740d8 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.mdx index 67707266aca..030575766b1 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.mdx index d299c62ae4b..dab4c19003b 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.mdx index 8560ce6c623..c55f4f17de8 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.mdx index 9fcb8711e93..5732fc19d63 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.mdx index 5b83d0fc3c0..ccd03504eb9 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.mdx index edecb88f8e1..142f8c84a01 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.mdx index 199b732e803..6eecd8c20f9 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.mdx index 8b02c0abe0a..0c48c88a677 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.mdx index 1252a2188e2..58115f5d3bb 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.mdx index b4341a92596..a4b02669e8c 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.38/qiskit.qobj.Qobj.mdx index 1840ca1357e..9d3ad17cc66 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.mdx index a3d5bcd2364..62532f50fa1 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.mdx index d9fdf7cf34c..4ee311d6025 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.mdx index 698c446e847..c9ecacc42b9 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.mdx index 03fbd022993..54f08a6909d 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.mdx index d13b94cf074..89ad2c88b9b 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.mdx index 6414f1d832b..8a91a91e5f2 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.mdx index 3fc2b198a78..5d6a98475d9 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.mdx index da87b76b4bd..93fadb314d2 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.mdx index 1be46c2dbb2..10d1d1b0876 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 5c3de65cbe7..724b5d0ee78 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.mdx index d8d729f03be..cc6d3df2d44 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a :class\`.QuantumCircuit\` While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -180,7 +180,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.mdx index eecdfdcad09..7f0ed98f95f 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.mdx index e3555349f6c..1c69f6218ad 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.mdx index 5408b62f142..63f13b69000 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.mdx index d4a1331cda9..57864d226f0 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.mdx index a0d79f1925a..c6a28ec1315 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.mdx index 7899019f29c..6e4b6b64d27 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.mdx index 2830339b93c..7eb96181490 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -176,7 +176,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -211,7 +211,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -237,7 +237,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -446,7 +446,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.mdx index cba3f15d4b5..474a4d86e16 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.mdx index d9093f1bdcf..6e923403ce5 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.mdx index b29cf4952d5..a6f737e6678 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.mdx index 204caa92663..214bcbda18e 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.mdx index 59c5d46284b..91b0de30604 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 2d531c306a6..3892fe3178b 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.mdx index f859c40ca51..fb6c7151831 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.mdx index 56985ebcf8e..dbbb1eb6ad4 100644 --- a/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.mdx index c00fd0cd2fb..ef6aa0e5dd2 100644 --- a/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.38/qiskit.result.Counts.mdx b/docs/api/qiskit/0.38/qiskit.result.Counts.mdx index 4d46630eee0..10ea4c8f094 100644 --- a/docs/api/qiskit/0.38/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.mdx index 5f85a6a6919..ce5ea9e1c9e 100644 --- a/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.mdx index 78ebd643054..b9712f618c8 100644 --- a/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.mdx index 01396eafbbd..86b8830003a 100644 --- a/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.38/qiskit.result.Result.mdx b/docs/api/qiskit/0.38/qiskit.result.Result.mdx index d765a17dc5a..d80b5f11e0a 100644 --- a/docs/api/qiskit/0.38/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.38/qiskit.result.ResultError.mdx index a301a3b3674..431e698e215 100644 --- a/docs/api/qiskit/0.38/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.38/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.mdx index cf8ada0a673..26d658cac6a 100644 --- a/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.mdx index aa66fb2b3fd..57b1d679b8e 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.mdx index ecf0663b5dc..7d887ca86e6 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.mdx index d8f7454c516..6b10d66cace 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.mdx index 796bfa030f9..491b4ac441b 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.mdx index b93ab62a1a3..1fe14f66a3d 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.mdx index f095b03efd1..2f2c6b6f5f6 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.mdx index a4b8e96fb73..99c99105a70 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.mdx index af46c393cee..24f188d99eb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -193,7 +193,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.mdx index a37084010d6..8a97bc388ce 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.mdx index ac8f3f748e2..a4f221e4607 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.mdx index 566b97c97b7..f4312594740 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.mdx index 6462c4094d8..54eefce24c5 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.mdx index 6d29487aea7..477a150f0a8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.mdx index 5b9fb3d0664..1b729e056ae 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.Layout.mdx index 03299a6a14d..4cacd2012d0 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.mdx index 007d266f7cb..87172e348db 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.mdx index 0719da9b472..cada02de61e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -37,7 +37,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.mdx index 4da1ebb6070..646c0c86327 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.mdx index 53f73913126..1bebf3653d7 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.Target.mdx index 5c901b14684..8489e86a737 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.mdx index 3169eff802d..fe698e36362 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.mdx index cd6458092d9..a790005f378 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.mdx index d2440214469..cc96a0fc43c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.mdx index 4b028a7d3df..ead7765f73f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 0a978826080..bb21f0dc23f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.mdx index 2b80fdeb6d5..bce44adf24d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 946a0b6d42a..684acc1f344 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.mdx index 71a519ca18e..35f1669ad6c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.mdx index f1fce10a450..6812675f27c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.mdx index ed4646abfa1..8534f4f53bb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 1c3a690030a..96c798b328f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.mdx index 85bc20416ee..0de77a46551 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.mdx index b61a070f7d5..59fb56bba82 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.mdx index e59439d570e..58dcdf59500 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.mdx index 7766ed6644f..376aad7a5ff 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.mdx index f13f59e89ab..0f52cc1ba4c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.mdx index 7d89b165959..02b40cf362d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.mdx index f8ae3228254..79fedc260fe 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.mdx index 3f15616d1d0..5a639bc9fec 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.mdx index 0f4d338d577..a286a3c0dba 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.mdx index ca2591e1281..5f5cb77e77d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 81c9ce2b689..045a47b0f7f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 4c32b6fdd5d..a234ac2b1fb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.mdx index 65753cad22e..05650bfa09a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.mdx index cbc0d6a7269..9210fd870a2 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index c5f504c808f..e4bcc263ff5 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 3b2c1f56408..aa722812fc6 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 3bc39a4bad3..c388e306411 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.mdx index d4c1dd772f7..13a6678c298 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.mdx index 9742bf60a22..d02596a7753 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 7eae4450236..e27c7120a2b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 397adb85e92..55dcd9f1873 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.mdx index 1757d1ba90b..aa80df92683 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.mdx index b7b8f4c76e6..0b565cda4c4 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.mdx index 1ca5c6e70a1..efc4dcdf72e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.mdx index 3af8045fb54..e869adbf851 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.mdx index b0083e50d32..835e6febb33 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.mdx index df0503d2e3a..70d11540d61 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 5a620067f10..dd4bd5e1718 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e7bdec967fa..e50ef252951 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.mdx index a9f8695e40b..51576562373 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 6a996622512..5e3ef1d7255 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.mdx index 24b34782a6c..c9b0d9d10ad 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.mdx index e7b67ffcdcb..cb2f1ac71d7 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.mdx index b0c3277668f..c92f073723b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.mdx index c4a43a9291e..c7756ce6e44 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.mdx index 73ebaa2b441..312971d3691 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.mdx index 65bc4c51979..b1aaee5b0f5 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 94a866eba97..54e61591b9b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize linear functions. Under the hood, this runs cnot\_synth which implements the Patel–Markov–Hayes algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 1724cd21f0e..d885df08864 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.mdx index 9db4b4540c9..ad262c915d2 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index a2563e85d7e..f4040c9b530 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 4e974340ad5..e1de0951429 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.mdx index b1edb981971..08f874e79e8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.mdx index b7934c88c7b..b437f7a15b8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index a1acd4d7081..82b50ed4eab 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 876c5468b20..9fa1d474812 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.mdx index 47c5965b11a..62fc6fad457 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 6033722ed3b..cf27d5b2dab 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.mdx index 8d745c8035f..e9750928b79 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index a7c94394d93..cebc4254038 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index a8b3e1ab1c6..01256d7b2f8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.mdx index 2d5291422e6..72ffc72a362 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index b7a82fa96fd..4bcb1372b4d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 67fb37c0e33..26ceb371296 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 813318b2a0f..fb9476ca2e9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.mdx index da98f233774..97db8175439 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.mdx index dfefd7ae347..e76f51e8cc6 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.mdx index 0121ebebe55..20268d4a707 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.mdx index aac40dcb06d..2849586e49f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.mdx index 74f991c39b6..39058c48f11 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.mdx index b270b6c2c27..542c59a9ddd 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.mdx index 985c1157222..ae7eaadfbc9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.mdx index 74261e31b77..98adabb851a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.mdx index 3b2bc88638e..4cca8ee2d60 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.mdx index 71cc2faf995..aafa5fbae49 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.mdx index f6719c7ae51..94f89841052 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 0c0cf7e2b6e..32f90fb0916 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.mdx index 6b3c755256e..0c5c791841e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.mdx index e7b664bf316..d743417c511 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.mdx index 9586e35afa5..e78da8d7457 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.mdx index 038ac1618c2..41392258dd2 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.mdx index 8a0f120a759..20d3f82d95c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 2baabd1ea3d..fc5ece7ea83 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index f13a1e59adf..cd0f5a117a3 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.mdx index 99979593fe2..5eb0278be4e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 26917e48514..9b6e97d19fa 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 3eb3a880f34..b7a3b44c8ff 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index d037894071d..27ba4a689ae 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 3f2f65d3437..d8571fdca0d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 33176c37501..dbf72c6ae00 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index ec69e448ad8..ec5b51748fe 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.mdx index 3b99584d10b..ef4bbd3c07b 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 35c1a30a9ac..8a82fc675c6 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.mdx index a3c2495d891..50f67e83d18 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.mdx index ad9285e0149..c665f349d3f 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 867487577e2..521767651e0 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.mdx index f1f0b007658..d795eaef352 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.mdx index aff3b79afcc..aa0f38bce70 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.mdx index c8e966e4648..3ae5b8d29f4 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerError.mdx b/docs/api/qiskit/0.38/qiskit_aer.AerError.mdx index 66c4e13cd2b..bc4246fecc5 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerError.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerError # qiskit\_aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerProvider.mdx b/docs/api/qiskit/0.38/qiskit_aer.AerProvider.mdx index 83553fba283..6cb35b4e67d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerProvider.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.mdx b/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.mdx index 15d0c1cb5cb..2219e89640d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerSimulator # AerSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -248,7 +248,7 @@ python_api_name: qiskit_aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.mdx b/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.mdx index 680f89325c6..3e7dcceae53 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.PulseSimulator # PulseSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit_aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.mdx b/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.mdx index 4f05cb95811..e6c5dacfc60 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.QasmSimulator # QasmSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit_aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.mdx index 602245254bb..0669453ecc0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.mdx b/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.mdx index d5c4f6adbca..ae9e1706729 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.mdx b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.mdx index 762da4cd279..83aa4047886 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.mdx index a684e03f988..b7e2ed0c8e3 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit_aer.jobs.AerJob "qiskit_aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.mdx index fff68b1030c..2900c0ef3a2 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.mdx index 33867082b15..48bb57671e2 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.mdx index 1eeffcceaac..ddfec7ecbfb 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveClifford # SaveClifford - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.mdx index a573e0dd34d..696b0328e4a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.mdx index a0cae095623..adfb60ec571 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.mdx index 41255c0b849..814ec8983d6 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.mdx index b5c561f77bd..7bb6558048e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.mdx index 617333d68de..61e1948f982 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.mdx index 4b239d6aaa2..1e6d7c9cc63 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.mdx index 8bf1c42063f..9235a1cd97d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.mdx index cac840b6e6a..697d54192c3 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveState # SaveState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.mdx index 10a521d27f8..0b95d90c52b 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.mdx index f5a2c163c9f..27936c46f01 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.mdx index 60b37afb883..e02001d6bf5 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.mdx index 4616d4a2d16..bb9fa1a0d58 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.mdx index 4d962939f50..12266c6a1de 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.mdx index 33459bbd404..ca7194f7e25 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.mdx index 7c0eba827d9..691a9e128c2 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.mdx index 8a41e86a152..cb0bedb8eaa 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.mdx index f186339b0a4..ed90972fd70 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.mdx b/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.mdx index 77bb1106ec9..84c725b3447 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.mdx index 8a9d7751b9c..f0667725f87 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.mdx index 370702a9edf..53dff784197 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.mdx b/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.mdx index a15e72a3852..5f29c8b940b 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -225,13 +225,13 @@ python_api_name: qiskit_aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.mdx index ef158325eed..9fb446a87a0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit_aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.mdx index 82df333c7d1..c463b06bb87 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.mdx b/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.mdx index 113d28f684a..c3731b50554 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") Aer implmentation of Estimator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.mdx b/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.mdx index 22c6ee7b78e..fcdaf133b69 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") Aer implementation of Sampler class. diff --git a/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.mdx index 91f245d5657..ac71eb491c5 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.mdx b/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.mdx index 846228d6d60..34919c1647c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector # AerStatevector - + Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") AerStatevector class @@ -191,7 +191,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -215,7 +215,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -241,7 +241,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.mdx index b85d4958bc2..ee89f97a5b6 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.38/utils.mdx b/docs/api/qiskit/0.38/utils.mdx index dbea23c8055..a6ebbb9464f 100644 --- a/docs/api/qiskit/0.38/utils.mdx +++ b/docs/api/qiskit/0.38/utils.mdx @@ -109,7 +109,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -149,7 +149,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -216,7 +216,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -230,7 +230,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.39/pulse.mdx b/docs/api/qiskit/0.39/pulse.mdx index 8a515b22613..c67cca94b26 100644 --- a/docs/api/qiskit/0.39/pulse.mdx +++ b/docs/api/qiskit/0.39/pulse.mdx @@ -67,7 +67,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -171,7 +171,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -189,7 +189,7 @@ And classical IO channels are children of: ### ClassicalIOChannel - + Base class of classical IO channels. These cannot have instructions scheduled on them. Channel class. @@ -238,7 +238,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -687,7 +687,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.mdx index 904769fe704..edeae943b66 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.mdx index 92ae248fcec..2c8d492b76a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `qiskit.primitives.primitive_job.PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.mdx index 27890980619..312ad9c210a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.mdx index d399dfc40dd..23b44e5b9c1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.mdx index a25720acd61..7c2be98b465 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -49,7 +49,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -70,7 +70,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.mdx index ecec481a6b5..bb4131e456b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.mdx index 09d6ad2a61a..4fd94e68257 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.mdx index ef8d0b16249..1e3e1077fd9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.mdx index 62dd15d7ff4..2abf1140c15 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` Pending deprecation: Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.mdx index fd670e0fe17..ca30879d125 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Eigensolver Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.mdx index 76e87d546ca..51b267b72ae 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.mdx index 4f51b2a1757..62089dec447 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Pending deprecation: Evolution problem class. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.mdx index e552a77d4ab..acf000abee0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Class for holding evolution result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 32a5660198a..8b54b18eef6 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index a0b983f19ce..4437e57149c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.Grover.mdx index 645e35214a0..6e4b05eed66 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -138,7 +138,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.mdx index 9cded7e7c21..7dc7fcb3a51 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index b61c8eac142..1a1e7e5cd3f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index ff03ce575f8..a40a30ea059 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.mdx index bf30b9a891c..3dbdea45a27 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Imaginary Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.mdx index af17e0774d1..cc0fd3964c8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 8ebe51bb8dd..0122fe05009 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index d505b59b86b..91cb814e440 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.mdx index b4d2636a388..278d612fde4 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 6b37e9703dc..c4f1b064786 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index ccf7b9208b1..a59dfb69464 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.mdx index 379631d61ee..f9133dbad7b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` Pending deprecation: Minimum Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.mdx index a63161b2821..daf4b6f39b6 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.mdx index 83d95f3692c..1260a83029f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: NumPy Eigensolver algorithm. @@ -49,7 +49,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 70c3b17357d..cc300e5cb65 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Pending deprecation: Numpy Minimum Eigensolver algorithm. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.mdx index 28bfb583ed9..a94bbcf6e66 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.mdx index 44b3f9a32f0..1cf92b7422d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.mdx index e339bb0bb2a..20df3d475b4 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.mdx index 35e246ae172..ade6cf42b00 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.mdx index ea8a0c694d9..ab299c5f297 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.mdx index d1a41572ad7..09f9f65b2a1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Pending deprecation: Quantum Approximate Optimization Algorithm. @@ -143,7 +143,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.mdx index 211a4c2176d..b88a41f6c55 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Real Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.mdx index 44b9b3d2e1a..f05b50026ab 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.Shor.mdx index 2f2cb0e5203..49ddc263549 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` The deprecated Shor’s factoring algorithm. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.mdx index 8af38ce0a5c..117f197ade2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated Shor Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.mdx index b21715cae12..1d699087e28 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: `object` Time evolution problem class. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.mdx index ab6f4581a42..03b6ef7def0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.mdx index d491d701c04..ce3a7208d3c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Pending deprecation: Quantum Real Time Evolution using Trotterization. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.VQD.mdx index f0dfbb8ded8..196bfd1aaa4 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: Variational Quantum Deflation algorithm. @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.mdx index beecca6beb6..8ad19440735 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Pending deprecation: VQD Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.VQE.mdx index f337827ee84..12bdd634a5a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") Pending deprecation: Variational Quantum Eigensolver algorithm. @@ -173,7 +173,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 9526058996a..8e70b038a68 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: `abc.ABC` The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 8e9203f9aca..259db76251a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index fed96aa090a..fea0f1395ac 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index f05625dbdef..3edf1083f15 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.mdx index 5837e24c647..fdd92c7b7d7 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.mdx index fa7b8c83689..fb7daee03af 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index 2f39bd881ae..ecb54b8ad99 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: `abc.ABC` Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index d0d67929801..2fffe40bdf2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: `abc.ABC` Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index 45629a8cb4f..65fa6368f9f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: `object` Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 7c03732a614..0de317686b5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 30f6c2c2684..01bfec6a064 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index abf80e4ef4a..2cf2c336b7b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index f80a70a4078..0856c847c49 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 2f09973a947..5ae656cd526 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index f487c3201a3..3eafc134a25 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 82eef88b2f9..4b5ba410346 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index eed959c776e..38d3d70cdb0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 00223a1b5ec..86132a345ed 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: `object` Result of SamplerGradient. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index 8fb67c4e66b..5926ad05476 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.mdx index fe2ca21140c..df75035f9e8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.mdx index 3f2a763622a..c0f58e088f2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` The deprecated abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 218adde87eb..bfa17c48d81 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated base class for linear systems results. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index 29111154a8f..188fd377b4e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` The deprecated base class for linear system matrices. @@ -263,7 +263,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -383,7 +383,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -500,7 +500,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1152,7 +1152,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1294,7 +1294,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1312,7 +1312,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -2128,7 +2128,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 4704161bf5f..46e9eee152c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` The deprecated abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 1f8e5adf574..55ad91c21c6 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index acd4fdd315e..89a37fa0a5c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The deprecated Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index 5304ab09146..83192a4e529 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of matrices given as a numpy array. @@ -289,7 +289,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -399,7 +399,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -409,7 +409,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1320,7 +1320,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1338,7 +1338,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 9cd8dcf6b71..db9393e4617 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of tridiagonal Toeplitz symmetric matrices. @@ -302,7 +302,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -412,7 +412,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -422,7 +422,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1333,7 +1333,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1351,7 +1351,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index 447637f107a..4350c6b5cb1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + 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") The Adaptive Variational Quantum Eigensolver algorithm. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index a6844760500..a61b46bb091 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index 0346c3abc77..56b09a7b5f5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index d1be503ce7f..537e03288fd 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 1a62141e7ce..a3fa853e396 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index 45e6aceb246..891fa1f579f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 6e602e90517..081a19407ad 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index e2667922446..b85798d49b5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: `abc.ABC` The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 32ff5a6cf0c..f96174b5126 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 52724351485..8ae837aa852 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + 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") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index 963024102fa..c052d616862 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + 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") VQE Result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index e65e4754e1e..b236a91b162 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + 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") The variational quantum eigensolver (VQE) algorithm. @@ -143,7 +143,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 094bc0df094..f41db16f41f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + 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") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.mdx index 49e94705dea..09143e5fc00 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.mdx index 68aef8c3990..d71baf07ca6 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.mdx index e21ca07b241..0cd9317589c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: `abc.ABC` Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.mdx index 47331336423..c2b3067c5e5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.mdx index fc7fc7f22ba..edbd1d7bd10 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.mdx index e5b936f3bf3..24adbdcbd5d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.mdx index 35240eff314..c57f1297557 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.mdx index b81b0952abc..75ff266e63c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 3f537b9244d..525a34168ec 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.mdx index dbcf3e5e987..d831d57aced 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.mdx index 1e562c08767..d766fa934c2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.mdx index 5d4be54c4ae..ce25340888a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -206,7 +206,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -322,7 +322,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.mdx index 18fe4d5a41b..0acac2515f0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.mdx index 7e1b9293337..5d4c38aae1e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.mdx index 09f805a1073..ad1fccbc1b5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.mdx index cabcc0691d2..6607ec370af 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.mdx index dd1ca346770..2c46dbdacd9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 8313ec3940a..f3f82f7c515 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx index 889c401fde8..eb945fc61ba 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.mdx index 1d87fdf3722..b973be34b3f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.mdx index 61dcb704592..1d1be4e2dfc 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.mdx index 448dc5ee06f..3f5e54e6d9e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: `object` Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 4fbf96bdf01..9a6979fa67a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.mdx index fd5de744977..1846a3ba521 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.mdx index 2d9c0cb8a18..78d0f61b2c8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.mdx index 1caeb1e956b..d390f09a421 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -184,7 +184,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -274,7 +274,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.mdx index 420a3104cca..0277db6523b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.mdx index dc5d1598d71..b1c5367ece0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.mdx index 0509b581e5f..dc7bc7f11c7 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 816e5e2a3a4..672310a6580 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index b11a7cd4015..35c43faf692 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](qiskit.algorithms.optimizers.SteppableOptimizer#step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -138,13 +138,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -212,7 +212,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.mdx index a279eef8bdc..1c0441f09f5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.mdx index 8bbefedbdb8..5672401dd79 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: `abc.ABC` Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.mdx index da3fe557f79..2b383143ebc 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index 3f8e55f4335..bdd1471aec5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: `Generator` Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index 8d9f66a26d8..be5c5f6af53 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: `abc.ABC` An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 23a3f09913c..f4a7ed0fa4d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 976030d1513..57f95407f4b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: `object` This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index 7876b48f0af..42a6d7aac6c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.mdx index f76ca969600..c7e741fc39a 100644 --- a/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.mdx index 1c85a3f55b2..6cef68439a1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.mdx index 637d501a4be..2bf3ce00984 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.mdx index cc0f8bc3af9..c8d85d1470a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.mdx index 4018bcf82ac..0936a499352 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.mdx index 833d6e4b672..6df02c195e0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Clbit.mdx index 4d5a7e4a756..3f92d1625cc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.mdx index 079623e5a6b..d1c63196bac 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CommutationChecker # CommutationChecker - + Bases: `object` This code is essentially copy-pasted from commutative\_analysis.py. This code cleverly hashes commutativity and non-commutativity results between DAG nodes and seems quite efficient for large Clifford circuits. They may be other possible efficiency improvements: using rule-based commutativity analysis, evicting from the cache less useful entries, etc. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.mdx index 91b7871f38e..7ec379bb6a0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.mdx index 3be0db9609e..80640ad4654 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.mdx index 842c57c0bdc..660f4f83ed7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Delay.mdx index 2349be09e19..e9f011c39bc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.mdx index a1278ceec3a..b3a2d53aecc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.mdx index d5b43e6d6e8..3de32892aaa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Gate.mdx index c79d26ebce6..14cd1e908b3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.mdx index 094271bcb7c..d06a3780acc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Instruction.mdx index aa77e393cfd..b25bdbbff4d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.mdx index 2544e2087d7..04d27772369 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Operation.mdx index 2e51399979a..aef4e11c284 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: `abc.ABC` Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Parameter.mdx index 4ce4d139918..f310eb9327b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.mdx index 65a8cce2576..5df42b4e6eb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.mdx index b212529f17b..16a07dd60a6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.mdx index c75d981e17c..864fe78e172 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -361,7 +361,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -471,7 +471,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -481,7 +481,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1372,7 +1372,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1390,7 +1390,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.mdx index a4f2b9c8b78..40fcdcf6714 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.39/qiskit.circuit.Qubit.mdx index 92f607ad6f4..4adeaca4546 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.mdx index 33a53aa2629..e27818332c4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 173c6f74d9d..077e1c6d668 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 043a5ddfe6c..2a7b168321e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 85cc705d343..a461902e442 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index ae70e4efb44..c04f2404efa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.AND.mdx index 90e45807e2e..a85f7d1a613 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.mdx index a5cda2546d9..636bb0156bb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.mdx index de1ae0a54f4..8d351919f87 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.mdx index da809a6367f..b56c38cbf95 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.mdx index 87be46ecce2..1053bdd00eb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.mdx index 8e804dfa7f5..a817f551739 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.mdx index 5b43b49ae87..e811d801866 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCZ gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index f1843138e40..f2e53a2b20a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.mdx index 7319a6fbd55..fdfb3266d2b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.mdx index dc07d7e29c1..bec12e58e54 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.mdx index dff56bd90c4..9ef45a2b52d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.mdx index 62f47a16253..22cd8a9b295 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.mdx index f577afeb935..00bfad4d380 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.mdx index 4a64e76fd79..3cb161f7f2a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.mdx index d9bd9d98cb0..76a1bcca004 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.mdx index 98286629e43..cb58e936854 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.mdx index e1360bddc87..4c16dec132d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.mdx index 52099235048..8a9c7678dd5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.mdx index 5b5adbd1e57..8ce330fce0f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.mdx index 59762eb23cc..7593b02fbf5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.mdx index c0ce213cdaa..9f2d6b1e48f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.mdx index c10bdf45f54..8dd5a4e397f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.mdx index 3aa17ba6dcd..76ece16e589 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.mdx index 81383ee9fcb..4bc9842d109 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.mdx index fb4ed90e462..a5e749995d0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.mdx index 7f710416a34..f78e7662f99 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.mdx index 619212250a0..23902b3673a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.mdx index dbda7a2d7ab..99ea3c3eeb6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 48cd60c0d7c..2cc9457fbbb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.mdx index 36ae94dbc80..dfb8fc32038 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.mdx index 35af11262a6..7316d2e98fb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.mdx index 4dc88eb7c38..73b2afe5fe4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.mdx index 81278e73154..aa8b0e0ec10 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.mdx index 266cca225c0..99f2164b862 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GR.mdx index 726767361bd..26af0a37406 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.mdx index 22fa2325ee8..eb24377ab3b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.mdx index 10c61b3569c..0a90f7b7c7b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.mdx index e9ca6840129..5a5ed2f1302 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.mdx index 2e2469dcd52..8219faf6985 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.mdx index 0f73ad53264..f4007917d35 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.mdx index c0760e21f13..e8d94667bc3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index a0a26b2989e..a741c97a5c5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.mdx index f445e306d00..eb968229650 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.mdx index cddd47b190f..7bdce99647b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.mdx index 4b32f1a9a28..09c374b1a9c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.mdx index 52f3aa8e257..d3816511ffd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.mdx index b9162e4ddc3..bf00139b40f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 37581fcb1d9..4cbf7e1f798 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.mdx index f09e4f91466..7e1d65721de 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.mdx index af73accd568..08425b912fa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.mdx index d033ff2ae49..a3dd760ee6e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.mdx index a9792262de5..3d8ebd11000 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.mdx index caf94d8a61b..356424d1afe 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.mdx index ba9b63ee49a..12af899a0d7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.mdx index 8145bd4cdc3..0461f60b62f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.mdx index 2392a36b742..b943d24fffa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.mdx index 8a73e8a227d..0915a8a87b8 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.mdx index 93227a11018..80a7e62b128 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.mdx index ff63fd37bd1..b4860c2796b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.mdx index 9a31a9900a3..e4672fcf564 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.OR.mdx index 343d3e8949b..3247b127170 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.mdx index ed231320040..f5a47cd6dee 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.mdx index b9aca4e3c4b..1e909c478c4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.mdx index 97fa42d841d..dbab710c191 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.mdx index a50b5a40327..5d1c2281c1c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.mdx index 3d8dbcb5026..ac52de6b9f8 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.mdx index 24962012a2c..8b25ca686be 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.mdx index f010670e2c7..e013bf34e44 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.mdx index be96871eac7..77cf23d3db9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.mdx index 1cdf5c2a348..83169e9f0a8 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 5b15b8a356d..41a04dccbe3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index b5fc094bd0c..f96ab0cbd5a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.mdx index 7ab8ffc2d6a..35a6e7d0e49 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.mdx index 47606c7772c..082561ba237 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.mdx index e2c053831e4..2dc635e8248 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.mdx index 79150161449..cd144df5079 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.mdx index dbfb6f889d8..04584a6d7c8 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.mdx index f25bb86b8f6..9391c11b723 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.mdx index 62dbf939a89..a09672084ea 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.mdx index bc6766a800b..14facdd051f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.mdx index 66f981e583e..9ea2a5678bf 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.mdx index 968c8fd922b..c83adca41dd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.mdx index 38147d33e7d..27a300dfcc2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.mdx index 53faca7706f..575617481b9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.mdx index acb668368e1..df32d089a1c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.mdx index b569f8921d4..c0ae3061e32 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.mdx index 815814f506a..bf35047cf0b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.mdx index f68e7f299f5..7dcd3f9d421 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.mdx index d0239650da5..b3662d13be4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.mdx index 16d700b2135..7c5484654d7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.mdx index 9b4ad1ae048..680abafda33 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.mdx index 84bb6390e55..ba101929954 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.mdx index 154bf9988b0..0ae9223c176 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.mdx index 94e038c9a5b..27a20a607ca 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.mdx index 5a60b12937e..c253bff735c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.mdx index a016dcdbbd5..6dd9df4c88c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.mdx index 92d6f20dbf5..6433ea97ae4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.mdx index ed41484896b..664fe75371d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.mdx index 63ebc10064d..59d3d9a8421 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.mdx index 3a21a5f39b0..7c7c1d8fd6a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.mdx index b7bc55cea01..b64ebc4d8cf 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.mdx index 1e56aba710f..b62406fd961 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.mdx index c873e01b163..3ebd188b95d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.mdx index e829a72afb4..3844b0469bd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.mdx index 120468dc3c1..8f848bd906d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.mdx index a5c3991a87b..14b5c7d25f0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.mdx index b38ac5e2831..473b4f2cb7b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.mdx index 1e3e75e6960..0ce6f5a2418 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.mdx index 0f6fe3bf8b2..2438880cea1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.mdx index 3d6c693f750..8f85c01acf8 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.mdx index 52f3b7d4894..734b1a83d9d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.mdx index 11f93136c10..1284b3a69d2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.mdx index 35653f2ada7..474ea89b1aa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.mdx index edc83015c8a..4f807b90d63 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.mdx index f31529da8a2..6063a3233dc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.mdx index 00020461145..801bee3ff62 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. @@ -292,7 +292,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### from\_networkx - + Take a networkx MultiDigraph and create a new DAGCircuit. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.mdx index 7f8cb23d61a..901862f38c0 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.mdx index b2dbe071c24..30e4ccf1375 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.mdx index 6091a79009d..61529d8b704 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.mdx index f936aa71ef8..4c9a75e1d0c 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.mdx index 8366ecaa34e..684d7a9fc09 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.mdx index 46bf9f07562..2e8044d563e 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.mdx index bd52a444a40..89a8c4f67bd 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.mdx index 8a60fe16e53..b3d6af0949c 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.39/qiskit.extensions.Initialize.mdx index a7864819953..fa27489acbe 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.mdx index 3c6628b6a43..07faba9b277 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.mdx index 748e7a9663c..58762437f42 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.mdx index c71517d6eb3..2b44beb598c 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.mdx index 89cfc275512..5f3cb24d14e 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.mdx index 434392e20e3..2de85a78e0d 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.mdx index 6aa0cfac90d..50e02ca4056 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.mdx index 4c11512d983..5257edaccaf 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.mdx index 87e4b820054..49364bf1a9b 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.mdx index 78a5ddec290..d91ab668706 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.mdx index 41c1b87633f..acc3ce47e95 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.mdx index 3b20ffa77be..61e19aa66b4 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.mdx index ef336cd1635..b178d91b146 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.mdx index 5b95c389fcb..f465757758c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.mdx index dd338f2d409..fb356e574b1 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.mdx index 2bb16e3f67a..a67307637b5 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.mdx index 69406e8f515..3c18a99ed00 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.mdx index 788ebae9d16..cd2e1902454 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.mdx index 24f62ab20af..1283fd76151 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.mdx index 3259b874579..c052f24549a 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index e3d2294f028..cbfc88beb16 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.mdx index a2612ce075c..bdd1d9432d5 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.mdx index 37c0288d24b..88927e2bc67 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.mdx index 53d84c0fcaf..f67d6c5f600 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.mdx index 845f2add8cb..ed5abf382f4 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 4f750944937..4de274fc252 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.mdx index bcb97386728..7835760642b 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.mdx index 9491c53ae6a..9e850a84e8e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.mdx index fb146d6a716..2c0e4010f71 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.mdx index 2d3affa800c..6848a6361b3 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.mdx index 44db230609f..d463f0ccfcb 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.mdx index 3646ae92ad5..0a3119b2516 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.mdx index fd21fdd3e2b..7b89ed17d2e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.mdx index 44437fd4216..b4b6c73ce38 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.mdx index 5629d405779..8199d4a9767 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.mdx index df683069383..4acff798b5e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.mdx index 13a92994b80..a499056d078 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.mdx index 6fdda8d9c03..da988844803 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.mdx index 9b2c7045510..e5f20399ba5 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.mdx index 2bae9b327fa..2dc55679b67 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.mdx index 204038fe12e..b92ab365c6c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.mdx index e0a93bfda3e..5f54d894034 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.mdx index d758d52eb6f..7f083853806 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.mdx index a55e34d1cec..3abc1e84c9f 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.mdx index 99044a0f5a8..4dfec827486 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.mdx index 3d744f6d496..9073803f334 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.mdx index 81d902f6964..f0c817ddd3a 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.mdx index c0d2bd07983..6f236da3ee2 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.mdx index 6321b8c883f..cb214667f89 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 34db83ded61..8778158dc26 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 195563b96b8..efafab7899c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 996b0372b27..da631c273cd 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index b254172e640..04a9579fbb8 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 39dc9607b8c..8ec64e7062a 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.mdx index 47f1c37a9b4..c80892401b9 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.mdx index 4a40f768ee8..4b6428585c2 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.mdx index a744966ad9d..8d51bdb6262 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index e138e17da0d..db85cf0a3fc 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.mdx index 772bd9db9f9..9745204823c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.mdx index 4571ef84206..23ae2c0c310 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.mdx index f0ebe7d5c76..fe25c44318f 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.mdx index 9c3a4e54124..f72743272c6 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.mdx index 6c2df3e5956..34c5ff7f584 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Estimator base class. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.mdx index 7c21021fe86..d6241904ee1 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Sampler base class diff --git a/docs/api/qiskit/0.39/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.39/qiskit.primitives.Estimator.mdx index 1e403b769c4..48892d3a7b2 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.mdx index 21d3555da8f..2c6247599fc 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.39/qiskit.primitives.Sampler.mdx index f4303ca03e5..ed676c497d9 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Sampler class. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.mdx index 920b5ea1ec8..6e88330f350 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.39/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.39/qiskit.providers.Backend.mdx index a480c7f689d..eb1a3b9d2e2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.mdx index 8f416efb375..698f893b59f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.39/qiskit.providers.BackendV1.mdx index 79ad327fe18..65f636fdd85 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.BackendV2.mdx index 4c64e5d2531..40612fd7b4f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.mdx index 68e92b7d379..f3ccb7e840d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.39/qiskit.providers.Job.mdx b/docs/api/qiskit/0.39/qiskit.providers.Job.mdx index 5f1b60d130b..37311883353 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.39/qiskit.providers.JobError.mdx index 1aa6d14351e..101310b807f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.39/qiskit.providers.JobStatus.mdx index 8fd4aab9b55..a4b67280e95 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.mdx index 0a031cca951..31cd617e9b6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.39/qiskit.providers.JobV1.mdx index de1b884c26f..e4d13a644df 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.39/qiskit.providers.Options.mdx b/docs/api/qiskit/0.39/qiskit.providers.Options.mdx index a291cc803f7..e427f78586b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.39/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.39/qiskit.providers.Provider.mdx index d1f4475e813..7c56d12eedd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.mdx index 11a6584c0cd..43a31fefcfa 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.mdx index 162e680fa19..dd92d9a9ae2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.mdx index 12f0361c414..d8c3a2e7bb4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.mdx index bfde3649cd7..8e18038858b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.mdx index d02a66954bb..d4bd57cb636 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.mdx index 629e7233a76..450e3443870 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 55e1998ac3f..07fa6f012f0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 69252c814df..10a9f71bae0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 006baa8c5d5..15a16349182 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 5fc25c7d23b..8812fd56d57 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.mdx index a7e37d87a4e..a05e152a4af 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.mdx index ae35912c83c..e338bf6d69f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index 94f423b3565..7e08c8e0b00 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.mdx index f68aa781bed..fbb27bd1ebf 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 00df4cdf609..6ef7faa1c80 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.mdx index 744c32c9f01..9f3c71b392a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.mdx index be107bb630f..72a88cdae1e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.mdx index 824eb7bf479..6194dc8b666 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index e8e3d0012fa..4e14e7f8c25 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.mdx index 36cc465ec38..f2faa460b2d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.mdx index 66028c83377..b1eb78285c9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.mdx index 62fb828c36a..fe8dd17a5b8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.mdx index a9e0a7f7ee7..9180d8dc1a6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index e1a555e10ae..674ac88819c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.mdx index 3305df49d36..1b504099eda 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 864b2672ac3..a9838bbb62b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 2ecc6583e4f..6805ea0a535 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index 798b267f533..31630c9adc4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.mdx index 7b8c2255256..9aaf31cbdcd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 764b45e06c9..aee8e39fae8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.mdx index b8a05fbf11c..7540e74e1c1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.mdx index 0068a505207..82bd827a71b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.mdx index be40e87492d..1ba03f79d5a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index aaa46727910..5fef087f07c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.mdx index 7b316af42e7..f5ee613179d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index 20e35a5e190..ff0dc1698eb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.mdx index 0f149f08f80..0558d2010de 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.mdx index 4ee20bdc407..e52ee6c1cdb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.mdx index 99e9e18c8dd..ddaeba278d4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 6b8460c8e91..fa42e88b2e2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index 42165c25c11..77412d52312 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.mdx index c5f855d87a6..327e483417a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 293e9441664..8d1932f6294 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.mdx index 734a5487587..eafa4a1863b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.mdx index c58460e1c0c..544b15047d5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 29ad22da9db..d43604661ca 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 911bfd99a27..6ae11c77832 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.mdx index 20bf8fd6930..473c9fecba7 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 341492d92e0..bdbfcbc63d1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.mdx index 05edafc0794..1a0c5eebf8c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.mdx index fb825b2ccb9..6f6c224cd9b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.mdx index dd44f84597e..ba2676f1d6b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.mdx index 7771de37af0..d1395b82a2a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.mdx index 5eed406a565..bf1954c45d2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.mdx index 94eec97ba66..3f431c04e64 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.mdx index 849582ae138..334db2c5020 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.mdx index fc485b96cd1..978301bb16e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.mdx index 090e948ac53..eb24c367e41 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.mdx index 36ff36019e6..1744d1eca8f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.mdx index 6af113fe739..a23cdf75cf2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index 5785473c34f..b0ddaab7b4e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.mdx index ffaad09bf45..c4db84415f7 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.mdx index ab4bb0ad940..2ee6cd9ab7b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.mdx index 8957759642e..bb8fd8b2668 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index f01362ed2af..8a7c4651a78 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 677c3fa1bde..fd2dfe94d7e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.mdx index befdca68f6f..e153289d4f3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.mdx index cd283ae7dbd..b96be39c56d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index ab14a2dc56a..12fa047dbec 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 36619a46ead..bd82455d355 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.mdx index 4961b0ccf26..cad89e2057a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.mdx index afd09ef7f9f..4b5f0455a37 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.mdx index 26300465d08..df4c623066e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.mdx index ad4fd864447..0b6be77b86b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.mdx index 0032308a1c3..3b8092a91bf 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.mdx index c491411f4fc..5af2177ff90 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index f24b1baffde..509dea7daa5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index a2f948dbf21..216ea1da2bb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.mdx index 659ac6c7e76..fa2ab1d02f2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index 31a74a62b51..c6dd41e00aa 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index 937f70fff41..b37ea3ad5b7 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.mdx index 5e4582535b1..9209e925a37 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.mdx index ae22c05bf33..7d2eaeda93b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.mdx index ce1de9d1f57..2788d9f5bc5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 4c629f3240f..28d7ef87d97 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.mdx index c6ba16fde48..d51d0733b09 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.mdx index b3150b96f45..a612fe89191 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.mdx index f3fde19883c..cef6cc9ba0f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.mdx index be59c67a242..2660fe02bf8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index f040f22c231..73234095f3e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.mdx index 39a9193f9ae..b1563dfe71a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index 2e4b36bc6e3..2b6d6222fe9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.mdx index b43cc09607b..7e9882fdfd6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.mdx index 1183e223c00..5c159622a46 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.mdx index 6a3f3f4a30b..c56c10e08b1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.mdx index 93f230c1bd4..9c5da78a6a3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.mdx index b812fe9d7d2..450a5b8ce24 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.mdx index 7867b58bdeb..1f4819d0cb3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.mdx index e52b6f3b613..a5e79392474 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.mdx index 2d2fe91ff0a..2d91652e53a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.mdx index 007f0a4dbe6..441393694d0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.mdx index 61f06212fa7..3daa94de72d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.mdx index a67dde8278f..4ddd7a65e11 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index c9fd9291dd1..9aca5035e61 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.mdx index d70abbcb79e..b161eda5479 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.mdx index fae8ef9656a..765c8ff0281 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.mdx index cdeddffde9e..45e75e4c938 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.mdx index 08978953371..c6066f6952d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 77938eed65f..b62debef98c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 08324f4c785..6c1891afb4a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5e1f36a1ef0..11591b97239 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7bd9846736e..086ef5c02f8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.mdx index 5ede14ab55c..021978045af 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index c59e5af9b43..365d96ca0c5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.mdx index 5f50a19aac8..24f30f00baa 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.mdx index f8fd56fe3c9..4635a794f78 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index cfa5dc1a253..5d5279797c8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.mdx index 1025e5dab66..5e5087bfac5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.mdx index 2130a77110b..c7cae20bdd0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 467d2398c52..d5b0a4daf6a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.mdx index 0e1a378f9bd..d26ccb56456 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.mdx index 7e1548d1cb0..0202bc7b909 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.mdx index 4e66ec8b9a1..32c8d2d7dd4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.mdx index 100c51bcfd9..e92e302672c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.mdx index c4aa52f6b05..9ae4c8afb7c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 18cce35ed89..73a0f0e6ff5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 43ba66ed697..0d799ae020f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 0a14a917596..972837399a2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 6fb7ea75087..240333075ca 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 8eb4301abf2..44b546c722c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 644d3507432..73ae596305f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 3806bb8f5a8..167482f59ea 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index fd7a8cb6435..4fd6a4fd1e6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.mdx index cf73bb34b57..ee1c3c2481c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.mdx index df337b0a430..fc2f7094455 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 35a0cc6ba99..8f64345b896 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.mdx index 47dd3486da9..356a036be9a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a241f50de8a..95749d75f86 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 03fc1cf820d..bea5ed64106 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 7a9308801b9..39107919c9c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.mdx index d01acdace81..1206689f3a5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index ef785d44f30..3c5f7a79905 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 68fc1e67894..84038a821cb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 67ed3ea14c8..72c9835f3a7 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 8003237ebc0..c16e4af1d0e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 09e5727ca8d..190201a49d0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 0dcb7a64379..bc551f07f60 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index de50c05e444..ceacc699e63 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.mdx index 5c6ec461157..b36b28522dc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index dc3f7694a16..92a276dd987 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.mdx index 550c58cb49d..ac70efe12e9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 6ad2d0dcc96..7cd34a69761 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 81c7ede59f6..797d9fbd982 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index d0ab183f707..4aa930eeccf 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index a0adaecb07a..5b885f2d779 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e79f25b1745..d9be3834224 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 3959fb827aa..e891cf63722 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 0e4036b4bee..bdaf1e041b3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 526e10d5308..9b86a18a7cf 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 60fed36866c..25505c3be0a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 0f827e65be8..50d91643724 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.mdx index 63fd6efb245..0e30a2f2bd9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.mdx index 931f5f1b10b..df4e30701b3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.mdx index 0f00a9b39c6..5101ff2697e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.Command.mdx index 422e0382aa6..bf722b9c5a7 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.mdx index 84d47551db1..45c0f104adf 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.mdx index 9e79b2c0f36..e00d90b00e2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.mdx index a17c8926f05..04cc5b1970d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.mdx index 3c090f73b5e..4e790db365a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.mdx index 5301ed53456..8a1b70d9212 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.mdx index 878bb9b4b5a..2899703216b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.mdx index faae807a387..05957fe0ef5 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.39/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.39/qiskit.pulse.Schedule.mdx index eb456f0c245..fea8699b053 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.mdx index 37984a02bb9..4a72da593da 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` Time-ordered sequence of instructions with alignment context. @@ -434,7 +434,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.mdx index 9520138292d..319a2a28141 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.mdx index 1132d38a528..15871c5c3e8 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.mdx index 6b33e735f37..760f88bd31d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.mdx index ecb7fede483..2869bfcb89d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.mdx index 37897187eac..9827b866992 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.mdx index 9d9f447db7d..934f74ebb9d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.mdx index 998546ea883..9376f053875 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.mdx index 948e7b2f737..754005a1a50 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.mdx index bd24f6025c1..874e9d5bac1 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.mdx index ce6f0a3c84a..ef2bc026171 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.mdx index 929479c10fb..9ad438d18a6 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.mdx index c5ec0ac69a9..abf7b7510aa 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.mdx index cb9025aee70..36a2ea7a122 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.mdx index 28138120d3e..e29119f47b8 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.mdx index b15483fc93b..cc8623c9118 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.mdx index 6e09656b503..7a35afcb330 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.mdx index dfecd762d22..5ba06c14fdb 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.mdx index a838acd2f2e..05e99fd0c51 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `object` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.mdx index 40922f1caa4..07a10e81f5d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `object` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.mdx index e6411b1d786..e159774cd48 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `object` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.mdx index 8310b2f9470..1d9c50e17ce 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `object` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.mdx index 01836254d49..19dc6dd223e 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.mdx index 95342d6c10c..27c5f3f899f 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.mdx index 4c76bb2edef..249215184a1 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.mdx index a1e12ec7c0f..0be98e1b818 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.mdx index 7035008fb97..ffb0c2fa9f3 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.mdx index dc7ca92cffb..adb5b0270f6 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.mdx index 7196774289f..c5a462abe83 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.mdx index 1b739d1389d..fcd0e12ab21 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.mdx index a6735e437f3..7a51b2a1e62 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.39/qiskit.qasm.Qasm.mdx index eed2643096a..d3a5b044aeb 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.39/qiskit.qasm.QasmError.mdx index d90cdf4f808..1f83d02087f 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.mdx index 180e02467a1..218222b1d46 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.mdx index 5590f98ef73..dc9a7c6d6da 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.mdx b/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.mdx index fa34d606bdc..71bd4e810e0 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.mdx +++ b/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm3.Exporter # Exporter - + Bases: `object` QASM3 exporter main class. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.mdx index 1732b3cd044..5cb0dfadfdd 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.mdx index 9fe59c8f24e..fd68c33a1f6 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.mdx index 53ebcf2782a..de7dce1dcce 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.mdx index 41058dbcba9..576ea6c2b61 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.mdx index 0e4ca29d50c..6a54504576e 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.mdx index b01d155f2ae..8aec2fe306b 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.mdx index 3aa938db864..9427fe5df70 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.mdx index 9f455cee9ce..a8346b86536 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.mdx index e451acd062e..9cc17e02f71 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.mdx index ffdc84c0463..a6b41ae7334 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.mdx index 44c2d08c812..a804e9673e1 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.mdx index c6cadf3638f..90409df77b4 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.mdx index ca28f0f56fc..c80386211cd 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.39/qiskit.qobj.Qobj.mdx index 800c6d3b0f8..ca3ac5bc669 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.mdx index 53dfb5ae1b1..06519df2507 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.mdx index dc454827cc0..c79fe20bc78 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.mdx index db3758e7f27..fbc1d266b61 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.mdx index 2a202831215..74afbe5cdab 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.mdx index b4493156980..dddb34c8d95 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.mdx index 9d395bf8fe0..29eddecab4c 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.mdx index d3fe552d376..b079cfe2556 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + 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") An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.mdx index d9738f5d7ca..20a21051a84 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.mdx index 6dc957b3def..77b1b4301d8 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 9ac965429ad..db59b9710ee 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.mdx index f442da87e79..8055ef928a0 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -180,7 +180,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.mdx index c9b3755a3ba..c7305d3721d 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.mdx index 4eb104ad7e8..ebacb2e69ed 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.mdx index 5955df2eee3..a2b21216383 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.mdx index fa170729cdd..7e6a575fc5d 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.mdx index 025d453802f..25dc361822b 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.mdx index 3f91cfbe6a3..b19e8923a07 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.mdx index bd7a4f62d32..0a4c521b4b0 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -269,7 +269,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -305,7 +305,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -331,7 +331,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -612,7 +612,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.mdx index 916e93c7bb5..4af3a3570fc 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.mdx index 20edc39cc72..40984d31f5c 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.mdx index 7303429fc23..240cba4e232 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.mdx index 4ee7448b5f5..b03bc81adec 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.mdx index 8a110083e98..9e6b75b2c70 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 5dbe1fe0569..e3de0085e24 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.mdx index 6f0a357dc2a..5e07baf4108 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.mdx index 264e434d657..8a152360885 100644 --- a/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.mdx index b7d6cb5f306..e0cb0c9a83a 100644 --- a/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.39/qiskit.result.Counts.mdx b/docs/api/qiskit/0.39/qiskit.result.Counts.mdx index 29a0ee51ef9..48a0bf5658f 100644 --- a/docs/api/qiskit/0.39/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.mdx index 8dcc872326d..fae44b7f3bc 100644 --- a/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.mdx index eba31a4d687..72b13716b5d 100644 --- a/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.mdx index 33772642364..34f23b842bd 100644 --- a/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.39/qiskit.result.Result.mdx b/docs/api/qiskit/0.39/qiskit.result.Result.mdx index 7259ccd47ec..6c7f12f1a7e 100644 --- a/docs/api/qiskit/0.39/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.39/qiskit.result.ResultError.mdx index db8dc85c31a..929c6c20c73 100644 --- a/docs/api/qiskit/0.39/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.39/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.mdx index a8222bded19..db5a047b380 100644 --- a/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.mdx index 85f0025c9af..56f1e58e0bb 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.mdx index 1f7a708e84e..16e4531c2ba 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.mdx index be6b4870138..39c725923dd 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.mdx index 418fe6b76b7..f6cf7ef9a2c 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.mdx index 3a1e6afc73f..93a8b3c9229 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.mdx index 0ed2a7261d5..6cb6c8ab5fe 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.mdx index 254f2db6cc8..2a03cb9be88 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.mdx index 3d2df4238a9..cdb4a8ecca2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -93,7 +93,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -189,7 +189,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.mdx index 0067bd49ba6..d5cd0a2ba42 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.mdx index cd523030ef1..0238548c958 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.mdx index 08d1839d9d0..fd8b2335dba 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.mdx index 5ad6cf9a422..1816972aae6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.mdx index eb4a6bce277..d830449d407 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.mdx index 045296940ac..4b6e38470bd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.Layout.mdx index 57b780d10a7..6866999c35a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.mdx index e6af2fc4460..e5c071a4db5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.mdx index 28a6dd8aa4c..a62ae7ddee9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.mdx index 2d40fcf417a..60304eb3914 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.mdx index 32156ecefc2..415a7cc25a7 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.Target.mdx index a8343139d0b..b77e6748a23 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.mdx index eb6bbbd59d6..add922d47e2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.mdx index 59fa154450f..1d3b8d6935e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.mdx index 10768ca74d0..f063fdcf4b1 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.mdx index bc509dd8073..e14a72aa533 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 608a11c1ff9..950e9a81099 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.mdx index 2c8ebd72504..6caafc11823 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 1ff965ec2af..0e4900bfc3b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.mdx index 806b172ad19..0949dd85232 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.mdx index 6ff7788cbd9..442db0e3663 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.mdx index 98215958c64..12d94f14fa7 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 902eb423d5a..16467c6ad19 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.mdx index 704280ab4e5..c622c950127 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.mdx index 46a44f093f7..65d8b9aace2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.mdx index a871b9cbfd7..3251e3e75f6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.mdx index 6a8ba4e9194..24f4a7eb334 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.mdx index cacc71e1d57..efc1e6ac8df 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.mdx index 8a6ccc73a86..f3428c890ab 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.mdx index 02da4ad6461..f9c46f474b2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.mdx index 7881d55e070..50c545b8575 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.mdx index 82dfc31deac..96d0eaa8c34 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.mdx index 31b229d5f73..c3bbc3b86ef 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 1f2921ecb50..36c76c18734 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 97c8d09dc0c..912c2b6d4f9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.mdx index e3a9865e418..c7e6ea33e1d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.mdx index a16a1a9126b..5cbceb7faab 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index 2b02c3a9053..83d6a6116cd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index c343304084c..a8bcb8bb433 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.mdx index da6982ae425..09edb102de9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 052fb008c71..677ad2f6568 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.mdx index cff6b96c7e7..459ef78ec84 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index d4084606edc..9ae08ea1113 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.mdx index b2cedab8c0a..8e49da2defd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 2c11a63b752..39c02d25f45 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 6e274df4f5f..42620539360 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.mdx index 64b348f351a..09ebb87882c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.mdx index 8b48a24010b..3aed6dffe12 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.mdx index b2eeeb9fa0b..6c418582844 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.mdx index 39bdc646b3b..7ef1de05e35 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.mdx index d33d01b5567..8041555d990 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 3b9e9b68211..5efbe5f3aea 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 82abd5dfb59..791431e4781 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 4310c8c82bb..31343b11b65 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.mdx index 71b789d5cc6..0d0c260a0d8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 5249f3a2bc5..fa8f4c7bdbf 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.mdx index 341f7458fc8..ca22f641f8c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.mdx index 15c997e7217..d3cc510b2f8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.mdx index 8b77d859c13..cdeb03c9b08 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig # HLSConfig - + Bases: `object` The high-level-synthesis config allows to specify a list of “methods” used by [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transformation pass to synthesize different types of higher-level-objects. A higher-level object is an object of type [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") (e.g., “clifford”, “linear\_function”, etc.), and the list of applicable synthesis methods is strictly tied to the name of the operation. In the config, each method is represented by a pair consisting of a name of the synthesis algorithm and of a dictionary providing additional arguments for this algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.mdx index cc0f8eba42b..e7c7b3dd78d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects by choosing the appropriate synthesis method based on the object’s name and the high-level-synthesis config of type [`HLSConfig`](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig") (if provided). diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.mdx index 970356d0cc7..e035c6945b9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 16bc819ceed..ee3684963b2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.mdx index 5fa7d5b2bcb..640eba09355 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.mdx index d6d13dceeb7..d74cfaa37f6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 439c2315305..41076e48bfc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize linear functions. Under the hood, this runs cnot\_synth which implements the Patel–Markov–Hayes algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 45a5f47b780..aec0b51ab5b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.mdx index dbe3ba11be7..6b1b5cf54d3 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 79f8b0f4d01..0489ece2a3e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index ce0c8b56cf7..59cd28fea0e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.mdx index 2162b002b80..21578bab212 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.mdx index c238dfacda4..6c88f7941ad 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index de42442cda8..629bd4b0a46 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index a6d918d5d3a..7786ab4d11a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.mdx index 4b2af7a0b5b..9bd5cea5fdf 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.mdx index ec9fce70a54..82ba1f9d80f 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 59e24ff5b3c..ff054da03fc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.mdx index 60b1333f3e8..82e2c09acda 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 01d7db8ac8c..1a59e494038 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 2422f0d1e9f..00bae17f788 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + **Parameters** * **instruction** ([`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.play.Play")) – The instruction from which to create a new shortened or lengthened pulse. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.mdx index 37e4e0e0204..ce4b79de469 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 1b37b48b5f4..36b2429b2b6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 4fdfb5584e7..1eb796204f6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 86e53f0c844..d0736202370 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index 37a65f64c85..83db7c6a95b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.mdx index 805f306968c..c66f19564ec 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.mdx index 3703c130cef..57c45da1fe6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.mdx index 89d02d388d3..4c0e4236f1a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.mdx index 97c680ec1cd..4564e9d430b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.mdx index 8205c69379b..8059bfab8cc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.mdx index 81c7e1382fa..a2a5813a438 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.mdx index 6b8d42c3af2..9c5c004da70 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.mdx index cfd103763e8..69dc0007d90 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.mdx index 2f88b173ed5..998a6cc38e1 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.mdx index 26c4c3184a3..3c2c442bccd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.mdx index ac30e34fa51..0530977119d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 56b0a10a482..389d25389e9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.mdx index f85b9147405..c33c345305f 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.mdx index 424ba3e5bbb..6786e7c4c7b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.mdx index 44cae365003..24cfe7a4e40 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.mdx index cbaa9f5a4c5..bf91be9778a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.mdx index 88e98fe368b..7bfdedbfb5e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index 43c663864bb..8991d927f27 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: `abc.ABC` Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 192e0ef8420..13bb85b4db4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: `object` Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index bb80ca499d1..4d253b90809 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 83a07d3b622..2d901403ff8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 3be00843f95..2385748ef34 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: `abc.ABC` A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 7aeb606800a..a6a14308e4d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: `object` Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.mdx index 4849c46b5d9..9394940a911 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index bd589079e01..fd265cb6870 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index bd6f8eaf60f..ac57b9547dc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 6d42198941d..971fc9529ea 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index cffd9845588..0777b7c8ff0 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index b8042d385b6..118f46c43cb 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index 6a4ebc82270..aedfe3e5131 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.mdx index da307334b7e..773d2884a76 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.mdx index a94206b802c..f8a0cd4de32 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 63bf36cd2c1..04340f3aa5a 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.mdx index 8c691ccf7c7..52908a14e4f 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.mdx b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.mdx index 7acc6572472..285cf5bdf7c 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.mdx +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.mdx b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.mdx index ed8b1e9bca5..a7733f5a027 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.mdx +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.mdx b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.mdx index b6321082417..bfbb4912c6f 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.mdx +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.mdx index cccd61d78f8..1d72fe31d26 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerError.mdx b/docs/api/qiskit/0.39/qiskit_aer.AerError.mdx index 66c4e13cd2b..bc4246fecc5 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerError.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerError # qiskit\_aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerProvider.mdx b/docs/api/qiskit/0.39/qiskit_aer.AerProvider.mdx index 83553fba283..6cb35b4e67d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerProvider.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.mdx b/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.mdx index 15d0c1cb5cb..2219e89640d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerSimulator # AerSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -248,7 +248,7 @@ python_api_name: qiskit_aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.mdx b/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.mdx index 680f89325c6..3e7dcceae53 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.PulseSimulator # PulseSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit_aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.mdx b/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.mdx index 4f05cb95811..e6c5dacfc60 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.QasmSimulator # QasmSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit_aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.mdx index 602245254bb..0669453ecc0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.mdx b/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.mdx index d5c4f6adbca..ae9e1706729 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.mdx b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.mdx index 762da4cd279..83aa4047886 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.mdx index a684e03f988..b7e2ed0c8e3 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit_aer.jobs.AerJob "qiskit_aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.mdx index fff68b1030c..2900c0ef3a2 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.mdx index 33867082b15..48bb57671e2 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.mdx index 1eeffcceaac..ddfec7ecbfb 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveClifford # SaveClifford - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.mdx index a573e0dd34d..696b0328e4a 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.mdx index a0cae095623..adfb60ec571 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.mdx index 41255c0b849..814ec8983d6 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.mdx index b5c561f77bd..7bb6558048e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.mdx index 617333d68de..61e1948f982 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.mdx index 4b239d6aaa2..1e6d7c9cc63 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.mdx index 8bf1c42063f..9235a1cd97d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.mdx index cac840b6e6a..697d54192c3 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveState # SaveState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.mdx index 10a521d27f8..0b95d90c52b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.mdx index f5a2c163c9f..27936c46f01 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.mdx index 60b37afb883..e02001d6bf5 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.mdx index 4616d4a2d16..bb9fa1a0d58 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.mdx index 4d962939f50..12266c6a1de 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.mdx index 33459bbd404..ca7194f7e25 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.mdx index 7c0eba827d9..691a9e128c2 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.mdx index 8a41e86a152..cb0bedb8eaa 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.mdx index f186339b0a4..ed90972fd70 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.mdx b/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.mdx index 77bb1106ec9..84c725b3447 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.mdx index 87c57b791e2..6c9f6ce6030 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.mdx index 370702a9edf..53dff784197 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -244,7 +244,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.mdx b/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.mdx index a15e72a3852..5f29c8b940b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -225,13 +225,13 @@ python_api_name: qiskit_aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.mdx index ef158325eed..9fb446a87a0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit_aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.mdx index 82df333c7d1..c463b06bb87 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.mdx b/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.mdx index d1ad49d3a90..ff35908145f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Aer implmentation of Estimator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.mdx b/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.mdx index ca7b7e22209..ade9ee41ea1 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Aer implementation of Sampler class. diff --git a/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.mdx index 91f245d5657..ac71eb491c5 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.mdx b/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.mdx index 9dbea76225a..429a7ca20fc 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector # AerStatevector - + Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") AerStatevector class @@ -191,7 +191,7 @@ $$ ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -215,7 +215,7 @@ $$ ### from\_int - + Return a computational basis statevector. **Parameters** @@ -241,7 +241,7 @@ $$ ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.mdx index b85d4958bc2..ee89f97a5b6 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.39/utils.mdx b/docs/api/qiskit/0.39/utils.mdx index 47c1d025eba..3e76d45e1b6 100644 --- a/docs/api/qiskit/0.39/utils.mdx +++ b/docs/api/qiskit/0.39/utils.mdx @@ -110,7 +110,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -150,7 +150,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -217,7 +217,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -231,7 +231,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.40/pulse.mdx b/docs/api/qiskit/0.40/pulse.mdx index c5a1eb31809..92afcf8c168 100644 --- a/docs/api/qiskit/0.40/pulse.mdx +++ b/docs/api/qiskit/0.40/pulse.mdx @@ -69,7 +69,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -687,7 +687,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.40/qasm3.mdx b/docs/api/qiskit/0.40/qasm3.mdx index c653d6c0c21..d59e762e4df 100644 --- a/docs/api/qiskit/0.40/qasm3.mdx +++ b/docs/api/qiskit/0.40/qasm3.mdx @@ -61,7 +61,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -89,7 +89,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -157,7 +157,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.mdx index fcc057fd2da..a150f2d4fcc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.mdx index 94d9f94e629..c299ad6b322 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `qiskit.primitives.primitive_job.PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.mdx index 216c9011788..36fbe448b36 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.mdx index 20a7e00583e..9ea2ea96c6b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.mdx index 083496b6509..790a6501355 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -49,7 +49,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -70,7 +70,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.mdx index df24cf5d962..4aae1dbc54c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.mdx index 638fb02ab52..405dae3fd01 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 594fb796231..bc0dfdb74a9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.mdx index 1af65c9222a..751bc7d32a6 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` Pending deprecation: Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.mdx index e2835381ff0..7d3f565ce26 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Eigensolver Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.mdx index b2ed17124aa..43bcbac10c9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.mdx index 763dddac27a..653e2281299 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Pending deprecation: Evolution problem class. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.mdx index 08b5d565951..0c420e1b810 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Class for holding evolution result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.mdx index de725d4facb..ec39e6f9e7a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 5fea03f3607..5a7e09b0c2e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.Grover.mdx index 3710a223992..47a89e1fab1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -138,7 +138,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.mdx index 7d1e3afeba6..c8668c82934 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 625f6e90353..565bb20d9a8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index df6068f2148..d50f7143208 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.mdx index 8051ba3551d..16f7f34a45e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Imaginary Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.mdx index d36dd10c45d..988c87c9614 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 27171f5bbc8..a9d668dbbfa 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 7bc493401ee..5bd38d54a6c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.mdx index 8ba24fb4f64..a4a28b59b04 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index e086007ef84..3d376734646 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index af245beb807..37c75b67fb3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.mdx index d6d18b4c2ee..38b676a7951 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` Pending deprecation: Minimum Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.mdx index 3c0774e3cd0..528e5a412b1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.mdx index e37e683c0f4..b2392c2f12f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: NumPy Eigensolver algorithm. @@ -49,7 +49,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ce6b495c8dc..9d64c716650 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Pending deprecation: Numpy Minimum Eigensolver algorithm. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.mdx index 35468ea58d8..7c38520c89b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.mdx index 45403348844..d6ce20b1c84 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.mdx index 96ea2987d9a..b4727d7bc98 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.mdx index dfea8bd1b22..8f657b3f7fd 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.mdx index 8b6f88681eb..7bd698eddad 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.mdx index c4e2fff95d4..c470adb0713 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Pending deprecation: Quantum Approximate Optimization Algorithm. @@ -143,7 +143,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.mdx index bca635059b6..538c8c0fa39 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Real Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.mdx index ac1400cf747..a30eb97df2a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.mdx index c16e488c430..982009945b2 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.mdx index e33d71b945b..2793b7e1e4b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.Shor.mdx index 4f2adc3dcca..7356036beae 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` The deprecated Shor’s factoring algorithm. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.mdx index 64ccac962cf..e1bc4bbaccc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated Shor Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.mdx index ad8e45deb12..d2bf61d4835 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: `object` Time evolution problem class. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.mdx index 62815763fc9..998e627029f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.mdx index 73044eb4424..37c23e39399 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Pending deprecation: Quantum Real Time Evolution using Trotterization. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.VQD.mdx index 7f0c0c52698..cbf787a1652 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: Variational Quantum Deflation algorithm. @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.mdx index 2ba324c6bd1..5012f675181 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Pending deprecation: VQD Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.VQE.mdx index f3fb7b24a7e..2b367b36f25 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") Pending deprecation: Variational Quantum Eigensolver algorithm. @@ -173,7 +173,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.mdx index 3e164e6e78c..c4720635c47 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + 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") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.mdx index 61dcbc840e5..0137bce72ce 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + 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") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 6c0d0c9ce20..afe96d38acd 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: `abc.ABC` The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 0c0a55598ac..98a25b5183e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index 0103c9133b6..5cea3155460 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index f368547f466..09ea54c2876 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.mdx index d4af35c20d5..ea6094d31fc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.mdx index ed2264846b2..b77f9a3d40b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index 4b72b5603d7..07c3f315d62 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: `abc.ABC` Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.mdx index d41c027ce1e..75d9cf88d75 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: `abc.ABC` Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index b3235c8d4ab..c65b751852f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: `abc.ABC` Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.mdx index 8656e43fe6a..b2fc5873f36 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType # DerivativeType - + Bases: `enum.Enum` Types of derivative. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index fa76385372c..6b1ac8c4403 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: `object` Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 4aba2bdeb66..90a872db23a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 10f9789ba1c..a373548f57e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index f64d1d0a977..2ef6d638d1c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.mdx index 12d9c32518f..1cd13c9349a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index e00c578362c..20ed9e178e7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 4b201c06686..6975b2bdd98 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index f960cf50fb7..85020bb55ba 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.mdx index 0a69e89764b..68f49539393 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: `abc.ABC` Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.mdx index 30ed7476a0e..55a7dc1ceb2 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: `object` Result of QFI. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.mdx index 1dd207a6330..15b0d015475 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: `object` Result of QGT. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index c629ccf338e..d20a511c8d7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.mdx index 0fe092089e7..07a44f43345 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 79f0e146dce..3e70517f956 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 0a40ab008df..8b898ab7920 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 0287233ec48..9ac275b1d81 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: `object` Result of SamplerGradient. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index 1714901e627..e96d1a83ef3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.mdx index 950b1d17b2e..fd0f757e0e0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.mdx index c624e2884f4..b26fef487b8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` The deprecated abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 132ecbd7f37..54cf3b406b3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated base class for linear systems results. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index 0ef3a28ee2a..9cac2b10fe4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` The deprecated base class for linear system matrices. @@ -243,7 +243,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -454,7 +454,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1057,7 +1057,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1173,7 +1173,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1192,7 +1192,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1210,7 +1210,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1982,7 +1982,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 3836e96908e..d38ab43c59d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` The deprecated abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 97688660e70..596b2d8abba 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index 0fa5fdeab41..e6a46367bef 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The deprecated Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index ce91f9810b3..a81ba180d3b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of matrices given as a numpy array. @@ -265,7 +265,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -375,7 +375,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -385,7 +385,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1195,7 +1195,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1214,7 +1214,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1232,7 +1232,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 8bf5225fe21..ff2f3fa1ee9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of tridiagonal Toeplitz symmetric matrices. @@ -278,7 +278,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -388,7 +388,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -398,7 +398,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1208,7 +1208,7 @@ $$ ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1227,7 +1227,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1245,7 +1245,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index cf02713dea8..73fb6ff3fbf 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + 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") The Adaptive Variational Quantum Eigensolver algorithm. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index 302f9998cfe..f25c7c3913e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index f96f09d2a65..40d611cf907 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index dc045734105..01faeb6cb22 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 92820d78c3d..9bb8d8719bf 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index a97fa61dfe3..6c63d7bd706 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 609a0358b84..408562032bd 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index c5011faddad..4d3faad78d2 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: `abc.ABC` The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 4b7020ebb98..fba3cdcf516 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 2ed1b4bbd49..bb25f35028f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + 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") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index b7619ad46d5..4508f354240 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + 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") VQE Result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index 4f1320dd2b5..76e4ae50811 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + 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") The variational quantum eigensolver (VQE) algorithm. @@ -143,7 +143,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 0034289a497..09b0c1a6738 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + 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") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.mdx index 020a9c777b8..6635acdcfc6 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.mdx index 744fbbe52b6..d301d705cb7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.mdx index 5d7496a0400..4799ab66ded 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: `abc.ABC` Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.mdx index add349b3738..665d042f88f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.mdx index e532c4bc8ec..e5ee38d992a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.mdx index cc4280a4753..25485ee61ca 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.mdx index 343768127f9..184270180a5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.mdx index 6dc9619c2ef..ac230122953 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index bfa6e54d60a..1cbf8dca525 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.mdx index a995a7cbef4..099c42126ad 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.mdx index 44f8152f270..6be53def3db 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.mdx index 8a631a9cce5..7736e983f3a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -206,7 +206,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -322,7 +322,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.mdx index b23bd61948b..786db881501 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.mdx index 2903e6ce05b..489178a847e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.mdx index c5aaedce6e5..3b0159dffa7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.mdx index b322d55fdf0..1e06e770ed9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.mdx index 35f2196a649..ef69320b66f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 12300228773..16f9ff4d338 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx index a03cd8048ef..8a02c6f6800 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.mdx index 9cc97fd6242..6852a374bb6 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.mdx index ab157755da2..ec1e3924094 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.mdx index e7211db34b5..f50e782c454 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: `object` Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index a4edb07b745..a9f7e48fc94 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.mdx index d5b82e3f1cb..39760edef0e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.mdx index 0c7af90199c..5678dd03135 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.mdx index f5747cc6c35..b552dab6652 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -184,7 +184,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -274,7 +274,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.mdx index 401f7a14def..f975155beba 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.mdx index b8c9de235ef..b21a4789396 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.mdx index 125d3054cf9..befa6de0147 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index cb53fd95b58..17c6812b5a3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 0c1dc4f98af..f17aeff69be 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](qiskit.algorithms.optimizers.SteppableOptimizer#step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -138,13 +138,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -212,7 +212,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.mdx index d423c54804d..5f6b1c7655d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.mdx index 7aee7d3cb6f..b0dea7d33e1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: `abc.ABC` Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.mdx index e6c0c7d4a97..fa4869b3d7e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index cb3d3dcb882..70f558bbf8b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: `Generator` Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index b220fdcecd5..bbdc3f75294 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: `abc.ABC` An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 4b55c613d9d..61f4ddc453d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 620b9e59e0e..327a60ef55d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: `object` This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index c5b51202246..411141e661d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 746b8d467aa..c428243dcc1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `scipy.integrate._ivp.base.OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index 7d325ac0f22..3ffb8a59752 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + 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") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 74cc7ba6268..6d903b31606 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + 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` Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 96a8fca711d..adc6514a3a8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + 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") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index c6d723b1d0c..d9644b6f052 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + 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` Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 5127d402cf5..7681be50641 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: `abc.ABC` A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.mdx index a636d454710..2a90f68c89f 100644 --- a/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.mdx index 0d2147faf59..06bcbc2a880 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.mdx index aa5d4aa52eb..3da3c3b8383 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.mdx index 07d3c857667..049a3c4823b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.mdx index fc2c96836fe..e38f56323ab 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.mdx index 9141f5d7763..50df0e26ee5 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Clbit.mdx index 9e102befa82..58c40deb7de 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.mdx index 76c163cf855..6a49eebd883 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.mdx index 76e5018d15b..2775f534a5c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.mdx index b2283501432..7e8917afb52 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Delay.mdx index b311e194454..9a3937156f2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.mdx index bd635868fa3..712315317ff 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.mdx index d6fbd3fc5d8..5cfb9bba491 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Gate.mdx index f5d240c88da..b11019d9ee7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.mdx index 31bcba675f2..cc14c0159c3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Instruction.mdx index 745946d0f89..91c5c015db5 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.mdx index 955b42fedb7..25d3a390b4f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Operation.mdx index 24d22a0ced0..57589daaf93 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: `abc.ABC` Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Parameter.mdx index 3d51cdbff46..8a6b82a62fb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.mdx index 5c494f026f3..68317381b8e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.mdx index 34f54dac60b..33f0250a221 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.mdx index 2267a027ba5..8e4dbd266ef 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -325,7 +325,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -435,7 +435,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -445,7 +445,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1235,7 +1235,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1254,7 +1254,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1272,7 +1272,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.mdx index a68d0dc80a4..6044233dd93 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.40/qiskit.circuit.Qubit.mdx index 771a50e90db..a7a90bb22fc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.mdx index 8befccf2d7e..ee94f32a31d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.mdx index fc87dcabe97..48616f462eb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 159063c474b..5827d52145e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4ebaea6330b..f33ecb363fc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 8b3aec0b6d6..5c92c2c3088 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.AND.mdx index 9535a3f1a54..eb029d6d6a8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.mdx index b17f673c531..19cfa245c49 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.mdx index 3dd9679d265..584dbb1e42e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.mdx index e83bf73b49f..964e1d8d929 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.mdx index b79b4252670..2c7a94ed830 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.mdx index e91d255a553..7b376050fe3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 8af915f13af..b660411db6e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.mdx index 1a7bd9a26ac..14cbf46e916 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.mdx index 7a6ed46acb0..68b0547162c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.mdx index a497b2fb094..a2b6e668002 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.mdx index ab25c591290..937e6d89832 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.mdx index b4718c3cd4f..eba7b9e4b33 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.mdx index b1cdde0ca62..e8c736e94e7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.mdx index 2a779ea7be2..8a140c410a3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.mdx index 79bb8ad6b99..0d82113e633 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.mdx index acb83741061..df63a5c0daa 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.mdx index 8f8e6a03b01..253ab702558 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.mdx index 2e3f004ee35..c94ea252ba2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.mdx index ff67b7c9e94..91fb1f9790c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.mdx index 73b501a11dd..24c68b88fcc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.mdx index 352e7f0d0e1..607ac101bd1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.mdx index f29381248ab..923964271a3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.mdx index e8527f31ea0..b6ee7a1026a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.mdx index 6c20f5acc0a..c7c99a537a1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.mdx index a66535cd6ac..adbe3259c17 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index d060bb428f3..d2dbfa960de 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.mdx index a832cbc2de5..0ef70316fd1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.mdx index 079a7354998..54b39f1920d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.mdx index 682c607c042..00c61a45a8b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.mdx index a8270e4f5d1..846758882f0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.mdx index de711086576..2fab62084bd 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GR.mdx index 62f7b9725c5..f290584d7a6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.mdx index c6d5b14d52d..a9766d559ab 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.mdx index bb66306c41e..abe686b92b2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.mdx index c21a637ded8..841ed105c25 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.mdx index b1fa13a2133..1ce0a11a56d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.mdx index cf995c2b120..9cb6aa37679 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.mdx index e0ad512f200..bf59561fc7f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 3576791618b..9d72d469256 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.mdx index 8f5c2bbbde8..a32193374f9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.mdx index 3f0ccc8241f..35d4bf4fd1d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.mdx index 930a980cd6a..9a09a47a944 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.mdx index bcd39599e9a..fb2cd52b57e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.mdx index 9ceec7a390c..c75ae86c6ce 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.mdx index e97fc6c9d4c..108d46dbd03 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.mdx index 4ec4b9e86fb..0fe5ff9a164 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.mdx index 4c2c4f5fcab..d65436c383f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.mdx index ebda40050d5..550a490ce36 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.mdx index 5cb3e991705..59f2e34e136 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.mdx index aeaf309cbbc..f6326c90f59 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.mdx index 520350c5d8f..6f812f5485a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.mdx index f4a0555e344..cb5d5db96d4 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.mdx index f8e53c0f1bf..55e095f14c9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.mdx index 1760836210b..58c3d36bdb9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.mdx index c0a9b91cc65..6b31b83907e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.mdx index 9ab9a19e660..cd6efe65b26 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.mdx index 68010b13018..f02a7021e54 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.OR.mdx index d7fda28dced..01e77da27a9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.mdx index 331c88acb3b..f8934dbdb1f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.mdx index fa5a3c6f0b4..02515dbe4bc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.mdx index 589af1fd7f8..c32cd407055 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.mdx index 6977b6f53b5..69013c28d1f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.mdx index bf24e7f5755..904bcaf07b9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.mdx index f3af3f077e9..61ad8700fad 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.mdx index 58f7f3d80a3..429714a4974 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.mdx index 92ba57ada94..0258f2a1044 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.mdx index 07da7f7bfba..e8688eec4db 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.mdx index d628bc233b2..4781a8961dd 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index f37dbe9c018..de007541a87 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 0cdfede9571..0e5a7c41a2e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.mdx index d69ca266d9c..b15273bda00 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.mdx index 2dfc4a3e71f..818543149c2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.mdx index eadb315033d..2aad46b48b4 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.mdx index cc91d064cbe..b93f588a135 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.mdx index 067d248e0e8..4d878a7a0f8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.mdx index b3734648206..861537162ac 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.mdx index 8e995537778..afd4f1ddade 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.mdx index 0db6d64f938..67a095da56c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.mdx index 7b0cf56336f..0f601750f5d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.mdx index 1468f92abe5..e94e8ee9ab5 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.mdx index 96ce8ebf989..accec8f3907 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.mdx index b95c53a6913..c9217b405d0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.mdx index 97daef78b3a..a38a8fcc0c8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.mdx index 572a916ca7b..79f7c57e9c1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.mdx index 0ed04254cd6..70be751a721 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.mdx index 01281b666bb..ba4f81063ac 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.mdx index 0e297b29444..b63a91ef795 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.mdx index db0a9c5a09c..77e64794a74 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.mdx index 44fc0fab86b..98cf7a89cbd 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.mdx index a8445d89509..36af6d588e7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.mdx index d366c76dad7..759fb986d13 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.mdx index d83b75de530..ef153c12710 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.mdx index 5be5f7d2c0a..527f197a743 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.mdx index f43889f9622..244ceecab0c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.mdx index 83641ea35c4..113f3543410 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.mdx index a3f0b47402a..62bbe2a444d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.mdx index 9c9df17d31d..7af0337e634 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.mdx index 3edcf71389b..a837e3a8938 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.mdx index 5838abda1ee..2f812d91bae 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.mdx index 75a36996dbe..de928c02ed7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.mdx index 7fb6dfcc754..326aaf0684b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.mdx index c98e0351eb0..46bb4cae16f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.mdx index 8b79e258574..c81ace2e315 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.mdx index df2e253addc..8bc9308081c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.mdx index 9e486975237..0f884c9d84b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.mdx index f723f7d3dcc..42c24657935 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.mdx index 54bd40c41c0..ed28b89560f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.mdx index 60cc420122a..86954e0447b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.mdx index 2c38c05b6ff..cc7cd7cbf75 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.mdx index eee65dd8324..8e79b905416 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.mdx index a361e31f3a8..7b6e9f4ed9f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.mdx index eb759bd8fb0..ab617eb4756 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.mdx index f519d2278b3..f210ef754fa 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.mdx index 921190e1418..4af64f30b42 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser # BlockCollapser - + Bases: `object` Class to consolidate a given block from the dag into a single node diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.mdx index 7b7bafebb97..425c7f9734d 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector # BlockCollector - + Bases: `object` Class for implementing block collection on a DAG. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.mdx index e605c7cb4f9..502863bf847 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.mdx index 99ef26d93fb..c4995152d79 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.mdx index da4d9b1be7a..86969737551 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.mdx index 7075eb2776e..e37dbba1888 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.mdx index f4363b1816d..e2ae2c8bd14 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.mdx index 849582ac19d..21bb499d2f4 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.mdx index 41b22d7c5eb..f8e90471459 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.mdx index 5859547d934..b907e71c67b 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.mdx index 080ae94ba13..f338aa20a17 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.40/qiskit.extensions.Initialize.mdx index 626cc6e4293..739961fdc28 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.mdx index 8b9b86ec139..6d9916a34be 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.mdx index a3ffe1b4c7e..da3a1d66430 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.mdx index f9f778b716a..03b394314dc 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.mdx index b880c4c74f6..2f8e2800ef6 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.mdx index 8b575b2ab66..4a449078e26 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.mdx index bf82c0a8782..90c488f1c89 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.mdx index 97630076d78..eb5b47d2b4d 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.mdx index 1b526a646f6..9a9a49c3ec5 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.mdx index 1ca7ded6fea..87c97f5a59d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.mdx index b3603a834c5..979953aa3ff 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.mdx index 11547e894d1..7798994dd8f 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.mdx index 61f2ab5d897..152bfaf86ad 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.mdx index 5ffe5b3ed21..43a72dd7124 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.mdx index 07f02ec2d36..491936057be 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.mdx index 6e3460d10b6..bbefca6ddf1 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.mdx index e18c9262f3d..704dcf18ffe 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.mdx index f842b965af7..93ec69daec7 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.mdx index c6ed5b2625d..15f76105d7d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.mdx index 74cfcc30b58..27ddaa3874b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index fcd14f20987..9672668447d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.mdx index d68f81dbf3d..c996640f042 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.mdx index 16b8ec132f9..6195ac5e035 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.mdx index 44476a76afe..434d1459cad 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.mdx index cdb3fbe28b7..a64920d7053 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 730e39ed072..13edeea8621 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.mdx index 44ef970b145..76b52e6644a 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.mdx index 1da896ceb91..5b4b9affbc3 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.mdx index 746ab75f727..daaff9afbc4 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.mdx index 155fa9aeaff..d71e2d237c4 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.mdx index dfa3423bac2..6ad85175979 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.mdx index 099557b66a1..670788d5ed9 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.mdx index 5e87b6d2615..0d921851b52 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.mdx index cec4257a7b6..cc01ea178c2 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.mdx index faf96c659f4..4da7b6f9376 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.mdx index fde8e974a6f..0a95ab5aec0 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.mdx index 97c950783d8..15172ced512 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.mdx index 51b1e6eee7a..fdba0b78054 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.mdx index 4a219e1b469..0047c4df28c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.mdx index fe45879ca36..28c79099ae3 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.mdx index e176b7b65fe..6f62a06f814 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.mdx index 25f59ec85e7..9aa08f21880 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.mdx index 70afdcfad46..e81c53981c6 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.mdx index 12edc3e73fc..1345591db8c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.mdx index 92195695d1d..ebb760a249d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.mdx index e26101ada5b..b8e9c4c6a0b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.mdx index 1b80780b51c..0756830fa0c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.mdx index 4e15fa0d31c..b9d62bd9678 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.mdx index ad0736c2af1..67bf0ef7606 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.mdx index a7fdc74dca2..b08721d8742 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 903afc4c435..4bfcec0799f 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index dcf0b10bfc8..138175fd627 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 82acd47d2b2..ee19366191a 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.mdx index f30858525fe..c60ad20d60b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.mdx index 6763cb97247..8511a8a0fa8 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.mdx index 8caa38d8dd9..2944ae4b914 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.mdx index d047bcc2057..8fbe5d18496 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 6f666f7644e..3d3fdbd11c7 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.mdx index fa6f4d9c84f..663877c2891 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.mdx index f2294eb6556..0ad50012cbc 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.mdx index dc5b010f81c..b121b1e1234 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.mdx index 26890742e0a..7f9e04eb458 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.mdx index 63cdde00bb0..7f24b45f0bb 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Estimator base class. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.mdx index 0989924fcaa..b7ff3a6ec1f 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Sampler base class diff --git a/docs/api/qiskit/0.40/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.40/qiskit.primitives.Estimator.mdx index 6215f29ee13..bafa6ce7608 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.mdx index bbd9b42f9f0..bd77c2a48e0 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.40/qiskit.primitives.Sampler.mdx index cc47e0c14c1..8d68fd03d96 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Sampler class. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.mdx index e79f7762790..c7e83d31dac 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.40/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.40/qiskit.providers.Backend.mdx index 887f1859eea..a722474411d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.mdx index 1c0ee251000..b4c0d7c1121 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.40/qiskit.providers.BackendV1.mdx index f3e0d94bf8c..10ac94acc81 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.BackendV2.mdx index a7f331e06f9..14ec853a6ed 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.mdx index 89498edcdd4..f568a1fec3a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.40/qiskit.providers.Job.mdx b/docs/api/qiskit/0.40/qiskit.providers.Job.mdx index 64ab49b2f1f..da8f09fb4ea 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.40/qiskit.providers.JobError.mdx index 04707cbe24d..47ba2977096 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.40/qiskit.providers.JobStatus.mdx index 0cfaf9b16b3..08137bb31d6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.mdx index f9ee888fed4..4806d5aba83 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.40/qiskit.providers.JobV1.mdx index 6eb369c4710..96a08f05f51 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.40/qiskit.providers.Options.mdx b/docs/api/qiskit/0.40/qiskit.providers.Options.mdx index f5e5399003e..35425d604c7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.40/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.40/qiskit.providers.Provider.mdx index 5253ceb47a4..795171f3d79 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.mdx index ba2cf7bb355..cd2201e3ba8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.mdx index feff4c88e54..4501280e380 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.mdx index d8845e14628..6b836ac36a8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.mdx index cb4e32934a1..c713cccd06e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.mdx index c231aef7448..697c4dd1b3a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.mdx index 767dba44240..32556f1c6fc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9f71ccae670..ef1dc3666a0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index d6117097e48..aaf72892372 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index c75640861c9..bb50a8474d8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 3e4148932e5..1185d7e03bb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.mdx index 9f8bb6fdf7c..a7620da06ad 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.mdx index 9aaac799421..707eca9d8b6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index 63c687d80ca..be123945626 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.mdx index fffee430ac7..413dc1c34ca 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 2c6f1ad1be6..ebd7d9296d0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.mdx index 91a3a1f5935..9be4117ade3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.mdx index 20a26adac14..1ad0fd55d28 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.mdx index 9cd0fb9f07d..f93889056fb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index 3cac7353c03..5361fe78fc1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.mdx index b92c97fc251..5add323142f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.mdx index 0b578b3e5d7..57887cf63db 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.mdx index bb1c6c95ec2..eee23267e01 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.mdx index d8c5a078f4a..e50ff954b4d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index f3a77d4d519..57d76efdced 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.mdx index feb0307e877..a6d7f9ced96 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 0326b7cfaa4..cfadb5beab8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 5b6d073d20b..737679044b0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index afeb804a56f..984fa26b64d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.mdx index 662d6868d85..d845beeac02 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 028aa7423f7..4a71fc6550a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.mdx index d2646864f39..54cd4acad53 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.mdx index 3cc61b467a9..99a77c4ae26 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.mdx index 41237f4bde5..ad30400150b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index 2844c7b2781..7b0790e2ad3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.mdx index 9f1f4ddbdf0..63d78e8ee2e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index f5b5ce1a1e8..5a1dbd50162 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.mdx index 998b44ea7ed..35b0901ff3e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.mdx index 92fd3dfdda2..fb5dd96fe06 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.mdx index 65f7731e190..4eca354e0b9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 003fe202e9d..50d4701df7d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index 52736e02a9e..c01aa44aaa3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.mdx index cb9ccd58f13..dd22406b6f8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 7553c20ed91..86f54bd55e0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.mdx index 3d292daa1a2..151fd3179fa 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 1271bb54e36..b71c58c05b5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 275ee9eddba..d4430c413ba 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 40620bc981d..7c71ba09e95 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.mdx index 6539bf8545a..0ac4a7edc9c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.mdx index f3f155e45c8..348c58f1345 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.mdx index 3407a477e37..3335d0805b8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.mdx index 872bebb3431..8e0aa38669d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.mdx index 6d1f82c473d..5a03fa1a04d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.mdx index 62d24c9d73f..1cdac9aa927 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.mdx index df21c601ba3..eba394c76d5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.mdx index 90f1b4a8bc2..715e059adc6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.mdx index d106688b810..af49269b156 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.mdx index 9311d88aecd..05ae3d3cd92 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.mdx index c29f68c9c44..20269ab2ef0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.mdx index 12dde2ae5ed..25e03c8c755 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.mdx index f1a41cc718e..a186c520d48 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index 50cc8423f55..16a2f8af201 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.mdx index e41c60a71ff..e697edc6427 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 915eeeb7fb3..f6156ac6058 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.mdx index ddcbc95c712..2906e3acb33 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 17d3c3788f7..6010ccbe445 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 219a79b5e10..070fbf76859 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.mdx index 09f7c3051e4..ce74d6e3568 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 6fa94081348..4b733a71b72 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 7fba5b560a3..5bc008a933f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 28926314ca4..a25e799fd3a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.mdx index 8e4380d66a1..a5ef40bb657 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.mdx index 0147cce97bf..db5e649080b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.mdx index 982973b4a00..fae2b4d5b1c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.mdx index f7a52d282af..f889776b2eb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.mdx index 112817a89d2..f8861f01f4c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.mdx index 570cb6261aa..fe88bca415d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index f02e6d8f239..96b4886b769 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index 477b90dae73..67bfb162735 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.mdx index f49411bb985..6118766e2da 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.mdx index ebfc93e81c6..ab1a3c003ec 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index a66a9c08abe..d41796fe10a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index c5b88b5d511..fdc620d168d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.mdx index e7acf63d7a9..5600cb044b1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 77ca0994801..f2bff1312df 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.mdx index e276416aa4a..3f8dc4695a7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 6e0f2248c5f..d2246add54c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.mdx index ba28bd56585..424a0e85056 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.mdx index 300832db14a..10166e13b0a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 14669c66d00..70270962d9e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.mdx index eb67cac5985..d7317750161 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index c42c209f613..12e7c66784a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.mdx index f8809936589..faa2ae194f7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.mdx index bc82abbad06..dd665d8b3c2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index bbb8eba4dac..81d85530a61 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.mdx index 705c086ea10..b2a6a41dbb9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.mdx index a6708774a2d..b1ebacdbcb6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.mdx index 57163731369..2fad8d20670 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.mdx index e9faabb6245..e030ea3593b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.mdx index 176e11e63f5..f2d200ac129 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.mdx index d220ecc7f2a..86815a26e11 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.mdx index 64304d6d2d7..64a68f23162 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.mdx index a8bdf0c2d4d..acdf9a76e9c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.mdx index 77350f9f9fe..a744a8f40c3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.mdx index a7d4b963123..bfed5a126a0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.mdx index 24521e5440b..e0780e70ea9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 2a583cffca1..c8886b4133f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.mdx index 37cf3c9bc6e..078c8fc6ae6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.mdx index f072a12c718..b91f2a56127 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.mdx index cdeddffde9e..45e75e4c938 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.mdx index 08978953371..c6066f6952d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index 77938eed65f..b62debef98c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 08324f4c785..6c1891afb4a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 5e1f36a1ef0..11591b97239 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 7bd9846736e..086ef5c02f8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.mdx index 5ede14ab55c..021978045af 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index c59e5af9b43..365d96ca0c5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.mdx index 5f50a19aac8..24f30f00baa 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.mdx index f8fd56fe3c9..4635a794f78 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index cfa5dc1a253..5d5279797c8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.mdx index 1025e5dab66..5e5087bfac5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.mdx index 2130a77110b..c7cae20bdd0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.mdx index 467d2398c52..d5b0a4daf6a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.mdx index 0e1a378f9bd..d26ccb56456 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.mdx index 7e1548d1cb0..0202bc7b909 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -211,7 +211,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.mdx index 4e66ec8b9a1..32c8d2d7dd4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.mdx index 100c51bcfd9..e92e302672c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.mdx index c4aa52f6b05..9ae4c8afb7c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 18cce35ed89..73a0f0e6ff5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 43ba66ed697..0d799ae020f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index 0a14a917596..972837399a2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index 6fb7ea75087..240333075ca 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 8eb4301abf2..44b546c722c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index 644d3507432..73ae596305f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 3806bb8f5a8..167482f59ea 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index fd7a8cb6435..4fd6a4fd1e6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.mdx index cf73bb34b57..ee1c3c2481c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.mdx index df337b0a430..fc2f7094455 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 35a0cc6ba99..8f64345b896 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.mdx index 47dd3486da9..356a036be9a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index a241f50de8a..95749d75f86 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 03fc1cf820d..bea5ed64106 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 7a9308801b9..39107919c9c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.mdx index d01acdace81..1206689f3a5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index ef785d44f30..3c5f7a79905 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 68fc1e67894..84038a821cb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 67ed3ea14c8..72c9835f3a7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 8003237ebc0..c16e4af1d0e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index 09e5727ca8d..190201a49d0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 0dcb7a64379..bc551f07f60 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index de50c05e444..ceacc699e63 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.mdx index 5c6ec461157..b36b28522dc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index dc3f7694a16..92a276dd987 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.mdx index 550c58cb49d..ac70efe12e9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 6ad2d0dcc96..7cd34a69761 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 81c7ede59f6..797d9fbd982 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index d0ab183f707..4aa930eeccf 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -107,7 +107,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index a0adaecb07a..5b885f2d779 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -30,7 +30,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e79f25b1745..d9be3834224 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index 3959fb827aa..e891cf63722 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index 0e4036b4bee..bdaf1e041b3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 526e10d5308..9b86a18a7cf 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 60fed36866c..25505c3be0a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.mdx index 0f827e65be8..50d91643724 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.mdx index 5d433caad00..c21da4a2ffa 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.mdx index c9fda81e9a4..80a4315aa25 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.mdx index 7bb78b0a4e4..646ea3a3d07 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.Command.mdx index 65a4ea1db89..a381c5bd743 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.mdx index fd1bafd2ddc..64fae73c04b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.mdx index 570a87099d3..d1d7bd5223c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.mdx index 5d1bf50f811..d00725777b2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.mdx index 948ebe38e0e..4be8c157b3d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.mdx index 19eea837992..f08a9685936 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.mdx index 41101afc93a..d711cd26c41 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.mdx index 0303bd8125f..a1979b456b4 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.40/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.40/qiskit.pulse.Schedule.mdx index dd54ca2c1b8..137d3f63fbf 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.mdx index ffc2099785c..95f67fe763a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` Time-ordered sequence of instructions with alignment context. @@ -422,7 +422,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.mdx index 4f6d7d4c719..bc861fdb905 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.mdx index a78b5a833d9..6b522537751 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.mdx index 840339c240c..caadfac9ae9 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.mdx index 3c43da3ee95..52872b7349d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.mdx index 4d26850a2c7..4a65499add4 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.mdx index ecbc856ac01..e566453acc0 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.mdx index 8332d67699a..738a9994ed1 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.mdx index 1317b7b6258..87ed9849d31 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.mdx index 7eb3157cdb3..ee70120393d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.mdx index 2ea378c66f3..4b1d7c26ef5 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.mdx index d7a924c14be..f407b06dbe4 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.mdx index b34ac806d1b..4ca527d4343 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.mdx index 4268b6a9d23..789ea2c0663 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.mdx index d668e6c1bb5..1413f530f2a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.mdx index dd823d5974d..d80b914f9a9 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.mdx index 16b8fad4a74..f749ae9cc07 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.mdx index 5ae68cdd0c2..209270d3543 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.mdx index 92695d32e71..361269b515e 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.mdx index 3fc2bbd5a05..c8bb9586554 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.mdx index 6163dc7eda2..cf638b3550c 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `object` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.mdx index fa2663be2e2..e02dcf56fd6 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `object` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.mdx index 6045ee6973a..ba419a51dbf 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `object` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.mdx index 55e3f8c321e..13e9e688e63 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `object` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.mdx index 3b2e98df065..c35ebad5abe 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.mdx index 6cd51698489..eb71994c479 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse # ScalableSymbolicPulse - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") Subclass of [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse") for pulses with scalable envelope. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.mdx index d3f74350056..eeb078b722a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.mdx index d6fd9207a8d..8f22c7252d9 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.mdx index 699dab9077c..af0a0c3e1b6 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.mdx index b60836b72bf..58862c18439 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.mdx index 3af254d7186..49590b6b3f6 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.mdx index a52eef945db..3eba1d49adc 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.mdx index 46b0d55099d..96a8a1df936 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.mdx index e9f2be669f8..c7729c6cbe5 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.40/qiskit.qasm.Qasm.mdx index 3bfa2b53908..e816cc0d70e 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.40/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.40/qiskit.qasm.QasmError.mdx index c8873e06066..93833363baf 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.mdx index 05dce2c03ac..16b5ea61e38 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.mdx index 7e00f4c2407..8504807c2ba 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.mdx index 5b7e9a61f6c..d74f9f7ac6e 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.mdx index 4c3c320848d..19cb26de112 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.mdx index 8cfcfc082c5..2161c764599 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.mdx index 3998a8d6554..8e5c04b0613 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.mdx index a9db8f63a66..5265726f3c4 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.mdx index 2b756385b12..fb6c7ca4e46 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.mdx index 9dd6329a0ce..45439cbd3e5 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.mdx index a95788c6ed8..4bd63562087 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.mdx index 071a2701bfa..2ad387eadf8 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.mdx index 01ef04221d6..d6e04ed3dbb 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.mdx index 5511bde7f4b..c5ca81a51c1 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.mdx index 8c04d759ac6..0b325fff1be 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.mdx index f84c4c7897d..f0cfb72ecc3 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.40/qiskit.qobj.Qobj.mdx index 55e79ab2d96..741f8a34430 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.mdx index 919aa33c873..7a10fd7c458 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.mdx index 0080959e8f6..5d746d8c0d1 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.mdx index 67c78e5acf2..8eda984804a 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.mdx index 1562284cc6b..9a6af1ed2c7 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.mdx index d77c2417850..b7527c6bbdf 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.mdx index 2d2eb8acb37..d1ece396842 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.mdx index 3cf5f54fb6e..df1dbd8cf67 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + 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") An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.mdx index c8c2ed8400b..11043b65cba 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.mdx index 36d9bfb36b0..73840d9c9b5 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 57b38f236a2..5a8088b7ffb 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.mdx index c41c26cfd8a..82d1ba81b58 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -181,7 +181,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.mdx index 2d5851a795f..42c1ed023fd 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.mdx index f1d00e7882a..a70d1e15bbc 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.mdx index 4f9ed7927a0..6a5c3e587e0 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.mdx index 17baa7b1c1e..8e00bef3e0d 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.mdx index aa082bf87f5..00d28a88640 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.mdx index 2eac1eb97fd..57228f22ae5 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.mdx index b435a7683b3..d67c69b9753 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -269,7 +269,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -305,7 +305,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -331,7 +331,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -612,7 +612,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.mdx index ef576b0c0fe..e556be6cf9b 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.mdx index c5c19047a7e..5420750b1e8 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.mdx index dff1452de2a..29eb7941014 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -193,7 +193,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -217,7 +217,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.mdx index 26f1c11678e..fd6dac8a387 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.mdx index d5fc59f33e6..ad7ff0f3ef1 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 0290cf2e18c..c080d00f368 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.mdx index fe9ab6a3552..f6882ee1f2e 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.mdx index d2d70407b76..c5ac7d03f69 100644 --- a/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.mdx index d74bca8f076..ab06ba79062 100644 --- a/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.40/qiskit.result.Counts.mdx b/docs/api/qiskit/0.40/qiskit.result.Counts.mdx index f7a11750401..85aa945e454 100644 --- a/docs/api/qiskit/0.40/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.mdx index 2638218f164..a287ac90e77 100644 --- a/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.mdx index f8587dc2022..adbd050728c 100644 --- a/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.mdx index f551d88f8b5..b733a988051 100644 --- a/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.40/qiskit.result.Result.mdx b/docs/api/qiskit/0.40/qiskit.result.Result.mdx index 8cd4bd877a5..7d42e5a0137 100644 --- a/docs/api/qiskit/0.40/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.40/qiskit.result.ResultError.mdx index 0f55fbc6dc5..bfe69c22116 100644 --- a/docs/api/qiskit/0.40/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.40/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.mdx index 119b2bd18e7..819946bc691 100644 --- a/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.mdx index a80fbe0d1dd..bdcc28f39ed 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.mdx index 98daf53fdcd..f26b7876933 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.mdx index 0d4eea5fd12..bdeba1f8653 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.mdx index b594f084085..0148a3733ef 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.mdx index c6fc0c5e9b3..b069c90f0fb 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: `object` The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.mdx index 706e27d2336..0eb5c1d4d2e 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.mdx b/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.mdx index 3b3fa54541c..8f6081944cf 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.mdx +++ b/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.tools.events.TextProgressBar # TextProgressBar - + Bases: `qiskit.tools.events.progressbar.BaseProgressBar` A simple text-based progress bar. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.mdx index 295a631c7e3..c25a853a7b0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.mdx index d9b8db1d080..bfcd4875876 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.mdx index f4fafed070a..4c5daa88516 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -93,7 +93,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -189,7 +189,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.mdx index 7c6eaaa2c77..7fe570a3365 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.mdx index de1cf4ae53a..4d71f3c4e45 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.mdx index 87a7baca575..be1ee7ccad9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.mdx index 0c0c6845a02..400a1a199b9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.mdx index e60070c007f..95853a37c17 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.mdx index 33049c65c94..d40c042d370 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.Layout.mdx index 68a9f321f05..fa691ccfd2b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.mdx index b953f4dc664..0421780217e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.mdx index c94346776a4..6f3feaed451 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.mdx index 4c017f30d6b..b488ff3dd1d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.mdx index b372a35108f..7076638c4a6 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.Target.mdx index 10fd5e19eed..bcd7d2422b8 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.mdx index 7b874541f8b..404c67f794d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.mdx index e50155d6d53..289487edf1e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.mdx index 233e82112d0..d275823660b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx index 1597a6f9dd9..5774cca2726 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation # ACGSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.mdx index bc709e8cc66..e7cfd7d5246 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index cde990b13e7..0b3da63f960 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.mdx index 906fec4bf10..5ffc984c924 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 0be306576d5..de1ee66d540 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.mdx index 4809dd56583..cf83adbd9d2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.mdx index 57ed49629ba..a017b5a3baa 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.mdx index 594fa0babff..f388f968c0d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 0ba6e2c79e8..8f301cbc76b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.mdx index 5ee3f4a567e..3c8eb8b03f4 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx index 5db3ac502f5..7c28bae90b9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation # BasicSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on sorting. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.mdx index 7dc4127f258..f1c25993fd9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.mdx index fbd71707caf..1b5d61ee526 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.mdx index 6187966727a..b7188f59afb 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.mdx index f7d5ff0cad2..913e62f0dd3 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.mdx index 9579802bfb9..f9ff2fa3cdd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.mdx index c8c11c626a5..2fd03a955af 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.mdx index 16240158f20..9281a2a1ae0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.mdx index 4dea17057da..076f57e3b7d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.mdx index 4f71419a922..ded7ce800d7 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.mdx index 231c0c150bd..aa7cff5c360 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse # CollectAndCollapse - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A general transpiler pass to collect and to consolidate blocks of nodes in a circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.mdx index 0ef475ae766..3b03c862f69 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 94ca530af82..9bcf81db622 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index fa7b1410cb9..4dfadb3178b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.mdx index 3c8a2747d4a..e2817a37433 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.mdx index 55fc184cb7b..1fa6fa0906d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index d49dc963659..aa70816931c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index d1112cee107..8a423f2d52d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.mdx index cb9bdc5c269..796d8a473a0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.mdx index d1c4f9cf4d6..5b81043d765 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.mdx index 3aa30179981..09d7410423d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index 22a08f88511..26339c37b94 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.mdx index 0b0c96d80d4..b4baa215462 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 1127044f7fb..5100f430c1b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index f4d3c084d45..ba208ba832e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.mdx index 5e40ee4a25a..d5bbf8a8580 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.mdx index 902690eb354..5d460defe28 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.mdx index 32b1363b096..f26ebf56a95 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.mdx index 12d14cb6153..ecf8d895d69 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.mdx index 450217a6960..6da6a3723ab 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.mdx index cf2a6b62a52..1bf9008a8ea 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index c3947931765..1e88eaa13a0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 28831351b0f..5a41e9fd749 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.mdx index bfcd5062daa..d9da55beacd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.mdx index af229585b87..4cb66d992c1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.mdx index 3ddf9b6ee2d..6045c78cf5d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.mdx index 84d87c44090..666b5bf21fb 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.mdx index d006d8246a8..0dfa82d586d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects by choosing the appropriate synthesis method based on the object’s name and the high-level-synthesis config of type `HLSConfig` (if provided). diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.mdx index 0e739707668..0bb19292c57 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 9480119c285..a835c0ec273 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.mdx index 741e921953b..2d4d5ad9fb0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx index e3f207a075a..342a7bbf670 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation # KMSSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.mdx index a62fe11e77f..c030197a8cf 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 7a7e5818fb2..14a2c4b737c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index b7c9234b174..f1cd0eab785 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.mdx index c3e27c863dc..e9c0cc4059a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 3182cd3777d..d52f18cd0a1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index c7e5b614b6d..8b62a9f6e60 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.mdx index 1e841e85a91..c54c3061276 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.mdx index e2bd342f9ec..5665d883f5a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 62f8ab0194b..f98e0f3f990 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index b1dd28ac13e..7dea352de1f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.mdx index 5478fc11ba9..d5d406991ef 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.mdx index 7592bfa780a..662392749a4 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 405968f988f..731a5246ec2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.mdx index 8b60d53d0d1..d713d5b59b2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index fc85672d1d2..9d568aa5387 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index d75cd8c4a11..29f2b746f7e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.mdx index 1024dad2044..79a449229fd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index e8a7acab4d9..ab75f601ad4 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index d4c5c3a31ac..1dbd59ac1ee 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 98e77a93fd9..bb8819a0b0b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index bfbe5f210fd..6372c24337b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.mdx index ea2eb2f8599..32905b1fa94 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.mdx index f46ce853823..90ac10606ee 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.mdx index 3988177a07d..222968918ce 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.mdx index cb0d7a736c7..4be4c915a5e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.mdx index 3a8e2d07b2c..1738eff74d2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.mdx index d1669517db7..cca784db80a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index 8c0e3481fb0..ea94cf57e50 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.mdx index 57a91748a57..524dbb507ba 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.mdx index 354c1e8beb4..a5b7a41bd91 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.mdx index 6c7d4a74da3..0e7025499e5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 6488016c10d..250d5010291 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.mdx index a922a0c6a1b..1f02df35170 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.mdx index d4d334d9bc0..61fe06da331 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 2ba00ef143d..b7a4e90b523 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 90dc272f476..32b3af62390 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.mdx index 7b5ff13427a..a4eb84695aa 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.mdx index 2f0aa847253..c7398b0c8c2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.mdx index a0d38b3d6b2..489cf843383 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.mdx index a30fe7a491f..40e3153cc9c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.mdx index 1cbb4d742df..2824602612f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index fc04d692403..8802aeeab3f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: `abc.ABC` Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 362a790d3e1..5cb13d69755 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: `object` Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 875395beb27..d810acb27d7 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 53cc8283379..119faa702bd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 2e500eb86ce..3c7b4bef63a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: `abc.ABC` A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 2d0155cc7ab..360846da1d9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: `object` Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.mdx index 91e1508c3b0..6e2016852ae 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index e0e8281992c..4535a7f247c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 7360b6bf7df..49562385128 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index a74edbfc470..6ff295914ab 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 0589d4f7a85..bf806328d85 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 5dc1b341636..ea797281119 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index e8ac95e07f2..082dfe8f221 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index a2498d18465..c9e6d378d5c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.mdx index 36918667cfd..ffabd6a6b2b 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 83076757d9d..eec601dcc6d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.mdx index e39835bb1f5..b468b72b51d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.mdx index 4d55d258b3f..329da8e7312 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.mdx index 454f978b1a9..00f178bdac8 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.mdx index afe1fc6c6e5..7ad18446ec1 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.mdx index 389188a0250..b42ea8c80ee 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.mdx index 631ef20b2ce..c9deaaa23e2 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerError.mdx b/docs/api/qiskit/0.40/qiskit_aer.AerError.mdx index 66c4e13cd2b..bc4246fecc5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerError.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerError # qiskit\_aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerProvider.mdx b/docs/api/qiskit/0.40/qiskit_aer.AerProvider.mdx index 83553fba283..6cb35b4e67d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerProvider.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.mdx b/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.mdx index 15d0c1cb5cb..2219e89640d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerSimulator # AerSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -248,7 +248,7 @@ python_api_name: qiskit_aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.mdx b/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.mdx index 680f89325c6..3e7dcceae53 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.PulseSimulator # PulseSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit_aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.mdx b/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.mdx index 4f05cb95811..e6c5dacfc60 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.QasmSimulator # QasmSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit_aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.mdx index 602245254bb..0669453ecc0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.mdx b/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.mdx index d5c4f6adbca..ae9e1706729 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.mdx b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.mdx index 762da4cd279..83aa4047886 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.mdx index a684e03f988..b7e2ed0c8e3 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit_aer.jobs.AerJob "qiskit_aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.mdx index fff68b1030c..2900c0ef3a2 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.mdx index 33867082b15..48bb57671e2 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.mdx index 1eeffcceaac..ddfec7ecbfb 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveClifford # SaveClifford - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.mdx index a573e0dd34d..696b0328e4a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.mdx index a0cae095623..adfb60ec571 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.mdx index 41255c0b849..814ec8983d6 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.mdx index b5c561f77bd..7bb6558048e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.mdx index 617333d68de..61e1948f982 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.mdx index 4b239d6aaa2..1e6d7c9cc63 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.mdx index 8bf1c42063f..9235a1cd97d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.mdx index cac840b6e6a..697d54192c3 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveState # SaveState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.mdx index 10a521d27f8..0b95d90c52b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.mdx index f5a2c163c9f..27936c46f01 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.mdx index 60b37afb883..e02001d6bf5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.mdx index 4616d4a2d16..bb9fa1a0d58 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.mdx index 4d962939f50..12266c6a1de 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.mdx index 33459bbd404..ca7194f7e25 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.mdx index 7c0eba827d9..691a9e128c2 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.mdx index 8a41e86a152..cb0bedb8eaa 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.mdx index f186339b0a4..ed90972fd70 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.mdx b/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.mdx index 77bb1106ec9..84c725b3447 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.mdx index 87c57b791e2..6c9f6ce6030 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.mdx index 9b5e800c182..d6cec2f7b7b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -246,7 +246,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.mdx b/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.mdx index a15e72a3852..5f29c8b940b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -225,13 +225,13 @@ python_api_name: qiskit_aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.mdx index ef158325eed..9fb446a87a0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit_aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.mdx index 82df333c7d1..c463b06bb87 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.mdx b/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.mdx index a41197f2f2e..8cd420df35b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Aer implmentation of Estimator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.mdx b/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.mdx index ca7b7e22209..ade9ee41ea1 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Aer implementation of Sampler class. diff --git a/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.mdx index 91f245d5657..ac71eb491c5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.mdx b/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.mdx index 75a45f4c6e7..83fb1d3cdfd 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector # AerStatevector - + Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") AerStatevector class @@ -191,7 +191,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -215,7 +215,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.mdx index b85d4958bc2..ee89f97a5b6 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.40/utils.mdx b/docs/api/qiskit/0.40/utils.mdx index f21ff8c8ce0..ac6439fa39b 100644 --- a/docs/api/qiskit/0.40/utils.mdx +++ b/docs/api/qiskit/0.40/utils.mdx @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -151,7 +151,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -218,7 +218,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -232,7 +232,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.41/pulse.mdx b/docs/api/qiskit/0.41/pulse.mdx index 5323155c48a..b28380a4dca 100644 --- a/docs/api/qiskit/0.41/pulse.mdx +++ b/docs/api/qiskit/0.41/pulse.mdx @@ -69,7 +69,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -677,7 +677,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.41/qasm3.mdx b/docs/api/qiskit/0.41/qasm3.mdx index dac94f66d3a..d2acb3c21ee 100644 --- a/docs/api/qiskit/0.41/qasm3.mdx +++ b/docs/api/qiskit/0.41/qasm3.mdx @@ -61,7 +61,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -89,7 +89,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -157,7 +157,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.mdx index fcc057fd2da..a150f2d4fcc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.mdx index 94d9f94e629..c299ad6b322 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `qiskit.primitives.primitive_job.PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.mdx index 216c9011788..36fbe448b36 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.mdx index 20a7e00583e..9ea2ea96c6b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.mdx index 083496b6509..790a6501355 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -49,7 +49,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -70,7 +70,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.mdx index df24cf5d962..4aae1dbc54c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.mdx index 638fb02ab52..405dae3fd01 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 594fb796231..bc0dfdb74a9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.mdx index 1af65c9222a..751bc7d32a6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` Pending deprecation: Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.mdx index e2835381ff0..7d3f565ce26 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Eigensolver Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.mdx index b2ed17124aa..43bcbac10c9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.mdx index 763dddac27a..653e2281299 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Pending deprecation: Evolution problem class. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.mdx index 08b5d565951..0c420e1b810 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Class for holding evolution result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.mdx index de725d4facb..ec39e6f9e7a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 5fea03f3607..5a7e09b0c2e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.mdx index 3710a223992..47a89e1fab1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -138,7 +138,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.mdx index 7d1e3afeba6..c8668c82934 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 625f6e90353..565bb20d9a8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index df6068f2148..d50f7143208 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.mdx index 8051ba3551d..16f7f34a45e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Imaginary Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.mdx index d36dd10c45d..988c87c9614 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 27171f5bbc8..a9d668dbbfa 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 7bc493401ee..5bd38d54a6c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.mdx index 8ba24fb4f64..a4a28b59b04 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index e086007ef84..3d376734646 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index af245beb807..37c75b67fb3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.mdx index d6d18b4c2ee..38b676a7951 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` Pending deprecation: Minimum Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.mdx index 3c0774e3cd0..528e5a412b1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.mdx index e37e683c0f4..b2392c2f12f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: NumPy Eigensolver algorithm. @@ -49,7 +49,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ce6b495c8dc..9d64c716650 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Pending deprecation: Numpy Minimum Eigensolver algorithm. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.mdx index 35468ea58d8..7c38520c89b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.mdx index 45403348844..d6ce20b1c84 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.mdx index 96ea2987d9a..b4727d7bc98 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.mdx index dfea8bd1b22..8f657b3f7fd 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.mdx index 8b6f88681eb..7bd698eddad 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.mdx index c4e2fff95d4..c470adb0713 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Pending deprecation: Quantum Approximate Optimization Algorithm. @@ -143,7 +143,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.mdx index bca635059b6..538c8c0fa39 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Real Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.mdx index ac1400cf747..a30eb97df2a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.mdx index c16e488c430..982009945b2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.mdx index e33d71b945b..2793b7e1e4b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.mdx index 4f2adc3dcca..7356036beae 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` The deprecated Shor’s factoring algorithm. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.mdx index 64ccac962cf..e1bc4bbaccc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated Shor Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.mdx index ad8e45deb12..d2bf61d4835 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: `object` Time evolution problem class. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.mdx index 62815763fc9..998e627029f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.mdx index 73044eb4424..37c23e39399 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Pending deprecation: Quantum Real Time Evolution using Trotterization. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.mdx index 7f0c0c52698..cbf787a1652 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: Variational Quantum Deflation algorithm. @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.mdx index 2ba324c6bd1..5012f675181 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Pending deprecation: VQD Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.mdx index f3fb7b24a7e..2b367b36f25 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") Pending deprecation: Variational Quantum Eigensolver algorithm. @@ -173,7 +173,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.mdx index 3e164e6e78c..c4720635c47 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + 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") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.mdx index 61dcbc840e5..0137bce72ce 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + 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") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 6c0d0c9ce20..afe96d38acd 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: `abc.ABC` The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 0c0a55598ac..98a25b5183e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index 0103c9133b6..5cea3155460 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index f368547f466..09ea54c2876 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.mdx index d4af35c20d5..ea6094d31fc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.mdx index ed2264846b2..b77f9a3d40b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index 4b72b5603d7..07c3f315d62 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: `abc.ABC` Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.mdx index d41c027ce1e..75d9cf88d75 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: `abc.ABC` Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index b3235c8d4ab..c65b751852f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: `abc.ABC` Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.mdx index 8656e43fe6a..b2fc5873f36 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType # DerivativeType - + Bases: `enum.Enum` Types of derivative. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index fa76385372c..6b1ac8c4403 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: `object` Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 4aba2bdeb66..90a872db23a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 10f9789ba1c..a373548f57e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index f64d1d0a977..2ef6d638d1c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.mdx index 12d9c32518f..1cd13c9349a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index e00c578362c..20ed9e178e7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 4b201c06686..6975b2bdd98 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index f960cf50fb7..85020bb55ba 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.mdx index 0a69e89764b..68f49539393 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: `abc.ABC` Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.mdx index 30ed7476a0e..55a7dc1ceb2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: `object` Result of QFI. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.mdx index 1dd207a6330..15b0d015475 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: `object` Result of QGT. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index c629ccf338e..d20a511c8d7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.mdx index 0fe092089e7..07a44f43345 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 79f0e146dce..3e70517f956 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 0a40ab008df..8b898ab7920 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 0287233ec48..9ac275b1d81 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: `object` Result of SamplerGradient. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index 1714901e627..e96d1a83ef3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.mdx index 950b1d17b2e..fd0f757e0e0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.mdx index c624e2884f4..b26fef487b8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` The deprecated abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 132ecbd7f37..54cf3b406b3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated base class for linear systems results. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index 10ab4748069..3f4eb02b9cc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` The deprecated base class for linear system matrices. @@ -231,7 +231,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -442,7 +442,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1043,7 +1043,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1159,7 +1159,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1178,7 +1178,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1196,7 +1196,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1968,7 +1968,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 3836e96908e..d38ab43c59d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` The deprecated abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 97688660e70..596b2d8abba 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index 0fa5fdeab41..e6a46367bef 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The deprecated Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index 697f7efa54a..fc8154cef8a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of matrices given as a numpy array. @@ -253,7 +253,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1181,7 +1181,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1200,7 +1200,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1218,7 +1218,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 5fd00a45d71..19ef8229976 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of tridiagonal Toeplitz symmetric matrices. @@ -266,7 +266,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -376,7 +376,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -386,7 +386,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1194,7 +1194,7 @@ $$ ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1213,7 +1213,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1231,7 +1231,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index cf02713dea8..73fb6ff3fbf 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + 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") The Adaptive Variational Quantum Eigensolver algorithm. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index 302f9998cfe..f25c7c3913e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index f96f09d2a65..40d611cf907 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index dc045734105..01faeb6cb22 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 92820d78c3d..9bb8d8719bf 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index a97fa61dfe3..6c63d7bd706 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 609a0358b84..408562032bd 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index c5011faddad..4d3faad78d2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: `abc.ABC` The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 4b7020ebb98..fba3cdcf516 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 2ed1b4bbd49..bb25f35028f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + 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") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index b7619ad46d5..4508f354240 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + 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") VQE Result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index 4f1320dd2b5..76e4ae50811 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + 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") The variational quantum eigensolver (VQE) algorithm. @@ -143,7 +143,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 0034289a497..09b0c1a6738 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + 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") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.mdx index 020a9c777b8..6635acdcfc6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.mdx index 744fbbe52b6..d301d705cb7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.mdx index 5d7496a0400..4799ab66ded 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: `abc.ABC` Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.mdx index add349b3738..665d042f88f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.mdx index e532c4bc8ec..e5ee38d992a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.mdx index cc4280a4753..25485ee61ca 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.mdx index 343768127f9..184270180a5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.mdx index 6dc9619c2ef..ac230122953 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index bfa6e54d60a..1cbf8dca525 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.mdx index a995a7cbef4..099c42126ad 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.mdx index 44f8152f270..6be53def3db 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.mdx index 8a631a9cce5..7736e983f3a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -206,7 +206,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -322,7 +322,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.mdx index b23bd61948b..786db881501 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.mdx index 2903e6ce05b..489178a847e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.mdx index c5aaedce6e5..3b0159dffa7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.mdx index b322d55fdf0..1e06e770ed9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.mdx index 35f2196a649..ef69320b66f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 12300228773..16f9ff4d338 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx index a03cd8048ef..8a02c6f6800 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.mdx index 9cc97fd6242..6852a374bb6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.mdx index ab157755da2..ec1e3924094 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.mdx index e7211db34b5..f50e782c454 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: `object` Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index a4edb07b745..a9f7e48fc94 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.mdx index d5b82e3f1cb..39760edef0e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.mdx index 0c7af90199c..5678dd03135 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.mdx index f5747cc6c35..b552dab6652 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -184,7 +184,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -274,7 +274,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.mdx index 401f7a14def..f975155beba 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.mdx index b8c9de235ef..b21a4789396 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.mdx index 125d3054cf9..befa6de0147 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index cb53fd95b58..17c6812b5a3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 0c1dc4f98af..f17aeff69be 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](qiskit.algorithms.optimizers.SteppableOptimizer#step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -138,13 +138,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -212,7 +212,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.mdx index d423c54804d..5f6b1c7655d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.mdx index 7aee7d3cb6f..b0dea7d33e1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: `abc.ABC` Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.mdx index e6c0c7d4a97..fa4869b3d7e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index cb3d3dcb882..70f558bbf8b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: `Generator` Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index b220fdcecd5..bbdc3f75294 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: `abc.ABC` An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 4b55c613d9d..61f4ddc453d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 620b9e59e0e..327a60ef55d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: `object` This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index c5b51202246..411141e661d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 746b8d467aa..c428243dcc1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `scipy.integrate._ivp.base.OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index 7d325ac0f22..3ffb8a59752 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + 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") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 74cc7ba6268..6d903b31606 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + 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` Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 96a8fca711d..adc6514a3a8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + 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") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index c6d723b1d0c..d9644b6f052 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + 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` Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 5127d402cf5..7681be50641 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: `abc.ABC` A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.mdx index a636d454710..2a90f68c89f 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.mdx index 0d2147faf59..06bcbc2a880 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.mdx index 34017d7f758..bd333dccd96 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.mdx index 07d3c857667..049a3c4823b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.mdx index fc2c96836fe..e38f56323ab 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.mdx index 299160f7fef..5c2a74ebaa2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.mdx index 9e102befa82..58c40deb7de 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.mdx index 76c163cf855..6a49eebd883 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.mdx index 76e5018d15b..2775f534a5c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.mdx index f3760aaaa0b..9335b6a8e02 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Delay.mdx index b311e194454..9a3937156f2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.mdx index bd635868fa3..712315317ff 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.mdx index d6fbd3fc5d8..5cfb9bba491 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Gate.mdx index f5d240c88da..b11019d9ee7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.mdx index 31bcba675f2..cc14c0159c3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.mdx index 745946d0f89..91c5c015db5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.mdx index 0fde138f307..5c0ca4f15da 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Operation.mdx index 20959badd54..c8a6d791ec6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: `abc.ABC` Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.mdx index 1b222ac9d36..7d3b1bab2a7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.mdx index 5c494f026f3..68317381b8e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.mdx index 34f54dac60b..33f0250a221 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.mdx index 1bd4f8e9c29..a4876e03ab0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -309,7 +309,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1217,7 +1217,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1236,7 +1236,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1254,7 +1254,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.mdx index 3fddf68a1a4..73d55e2cea2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.mdx index 771a50e90db..a7a90bb22fc 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.mdx index 8befccf2d7e..ee94f32a31d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.mdx index fc87dcabe97..48616f462eb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 159063c474b..5827d52145e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4ebaea6330b..f33ecb363fc 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 8b3aec0b6d6..5c92c2c3088 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.mdx index 040f2fc9b3a..280d92e23dd 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.mdx index b17f673c531..19cfa245c49 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.mdx index 3dd9679d265..584dbb1e42e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.mdx index e83bf73b49f..964e1d8d929 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.mdx index b79b4252670..2c7a94ed830 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.mdx index e91d255a553..7b376050fe3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 955adf8a8db..3b49cbe2429 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.mdx index 1a7bd9a26ac..14cbf46e916 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.mdx index 7a6ed46acb0..68b0547162c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.mdx index a497b2fb094..a2b6e668002 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.mdx index ab25c591290..937e6d89832 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.mdx index b4718c3cd4f..eba7b9e4b33 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.mdx index b1cdde0ca62..e8c736e94e7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.mdx index 2a779ea7be2..8a140c410a3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.mdx index 79bb8ad6b99..0d82113e633 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.mdx index acb83741061..df63a5c0daa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.mdx index 8f8e6a03b01..253ab702558 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.mdx index 2e3f004ee35..c94ea252ba2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.mdx index ff67b7c9e94..91fb1f9790c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.mdx index 73b501a11dd..24c68b88fcc 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.mdx index 352e7f0d0e1..607ac101bd1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.mdx index 4e8542efbe4..f6e7c7f1829 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.mdx index 0fca29419ea..74b751eb13b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.mdx index 6c20f5acc0a..c7c99a537a1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.mdx index b309b8c5a02..f3184e3c81f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 124d04d5c80..663a3b30ef9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.mdx index 6cab5899f4f..a640876b673 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.mdx index 5bb3478eaff..f91359d55d2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.mdx index af5de270360..dc72d2015fb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.mdx index b74aaae3a35..11eaea2d721 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.mdx index 3f5015e1f44..6c6fac14f61 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.mdx index a3127df262c..04b15c0853d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.mdx index 1711c77fe63..bcab770c3d6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.mdx index 42f9c6cfed3..7d5e418f5a8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.mdx index b96d01a7d21..48cd6d41d9d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.mdx index 8dda58b8213..26e5d21fb0e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.mdx index 3cb55645d26..bc2b88f328c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.mdx index e0ad512f200..bf59561fc7f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index ffb7835b244..82d3688fb2f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.mdx index 3491e0f3ef2..87d79b01c99 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.mdx index 3f0ccc8241f..35d4bf4fd1d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.mdx index 2e05aadb980..610664bba25 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.mdx index f5a198d0cca..203febb925a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.mdx index 5a55147af09..b8c549ae507 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 2a42c17a105..33863aadd2c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.mdx index 4ec4b9e86fb..0fe5ff9a164 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.mdx index a8b1396cf87..cbdb66f7402 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.mdx index c893334dd42..934f2cc870f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.mdx index 80c23c3d3cb..dfd6901e035 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.mdx index aeaf309cbbc..f6326c90f59 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.mdx index 520350c5d8f..6f812f5485a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.mdx index f4a0555e344..cb5d5db96d4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.mdx index f8e53c0f1bf..55e095f14c9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.mdx index 1760836210b..58c3d36bdb9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.mdx index c0a9b91cc65..6b31b83907e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.mdx index 9ab9a19e660..cd6efe65b26 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.mdx index 7ec4d26e684..91c2b943f6b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.mdx index 28e90a4673b..28b1d53fe00 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.mdx index 331c88acb3b..f8934dbdb1f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.mdx index 58ed4f51c26..a43beac624f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.mdx index 589af1fd7f8..c32cd407055 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.mdx index ea08c59ac56..a20fc3a9d8b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.mdx index b07541c976a..a7641070a38 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.mdx index 0fcc52f6f56..1f8c11d9108 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.mdx index 078c3ddc37b..df313608479 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.mdx index 92ba57ada94..0258f2a1044 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.mdx index 3afaa02e923..165d8cb9a86 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.mdx index 18217736090..530cf769dc8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 5c072f9b9cc..e2314b8424d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 5c46baed35d..d8e4deb6672 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.mdx index 91b0d0c7164..135fe3e28f3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.mdx index 71e19f7c0bb..3f8696d289b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.mdx index 27356be4174..4109b42f8f7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.mdx index 4b9b180d7c5..a4db6671606 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.mdx index aa297a49bcf..ff90e12e94e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.mdx index b3734648206..861537162ac 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.mdx index 8e995537778..afd4f1ddade 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.mdx index 174ea477494..9f8a74c6705 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.mdx index 7b0cf56336f..0f601750f5d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.mdx index 1468f92abe5..e94e8ee9ab5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.mdx index 96ce8ebf989..accec8f3907 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.mdx index b95c53a6913..c9217b405d0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.mdx index 97daef78b3a..a38a8fcc0c8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.mdx index 572a916ca7b..79f7c57e9c1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.mdx index 0ed04254cd6..70be751a721 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.mdx index 01281b666bb..ba4f81063ac 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.mdx index 0e297b29444..b63a91ef795 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.mdx index d9924cbc5fc..1ef3f4e5338 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.mdx index 44fc0fab86b..98cf7a89cbd 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.mdx index a8445d89509..36af6d588e7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.mdx index d366c76dad7..759fb986d13 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.mdx index d83b75de530..ef153c12710 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.mdx index 5be5f7d2c0a..527f197a743 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.mdx index f43889f9622..244ceecab0c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.mdx index 83641ea35c4..113f3543410 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.mdx index a3f0b47402a..62bbe2a444d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.mdx index 9c9df17d31d..7af0337e634 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.mdx index f01c30ff5fc..c9caf881bd2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.mdx index 5838abda1ee..2f812d91bae 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.mdx index 75a36996dbe..de928c02ed7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.mdx index 7fb6dfcc754..326aaf0684b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.mdx index c98e0351eb0..46bb4cae16f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.mdx index 02fcf03d1fe..25e4423bb64 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.mdx index 88b6bc32878..179fa23435f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.mdx index 9e486975237..0f884c9d84b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.mdx index bc2bbd03e30..1c896c60438 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.mdx index 54bd40c41c0..ed28b89560f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.mdx index 60cc420122a..86954e0447b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.mdx index 2c38c05b6ff..cc7cd7cbf75 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.mdx index afe438417c9..8f7ee963142 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.mdx index a361e31f3a8..7b6e9f4ed9f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.mdx index e73e38a9442..ee798edd299 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.mdx index f519d2278b3..f210ef754fa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.mdx index 921190e1418..4af64f30b42 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser # BlockCollapser - + Bases: `object` Class to consolidate a given block from the dag into a single node diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.mdx index 7b7bafebb97..425c7f9734d 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector # BlockCollector - + Bases: `object` Class for implementing block collection on a DAG. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.mdx index e605c7cb4f9..502863bf847 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.mdx index 99ef26d93fb..c4995152d79 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.mdx index da4d9b1be7a..86969737551 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.mdx index 7075eb2776e..e37dbba1888 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.mdx index f4363b1816d..e2ae2c8bd14 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.mdx index 849582ac19d..21bb499d2f4 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.mdx index 41b22d7c5eb..f8e90471459 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.mdx index 5859547d934..b907e71c67b 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.mdx index 080ae94ba13..f338aa20a17 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.mdx index 626cc6e4293..739961fdc28 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.mdx index 8b9b86ec139..6d9916a34be 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.mdx index a3ffe1b4c7e..da3a1d66430 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.mdx index f9f778b716a..03b394314dc 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.mdx index b880c4c74f6..2f8e2800ef6 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.mdx index 8b575b2ab66..4a449078e26 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.mdx index bf82c0a8782..90c488f1c89 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.mdx index 97630076d78..eb5b47d2b4d 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.mdx index 1b526a646f6..9a9a49c3ec5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.mdx index 1ca7ded6fea..87c97f5a59d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.mdx index b3603a834c5..979953aa3ff 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.mdx index 11547e894d1..7798994dd8f 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.mdx index 61f2ab5d897..152bfaf86ad 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.mdx index 5ffe5b3ed21..43a72dd7124 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.mdx index 07f02ec2d36..491936057be 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.mdx index 6e3460d10b6..bbefca6ddf1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.mdx index e18c9262f3d..704dcf18ffe 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.mdx index f842b965af7..93ec69daec7 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.mdx index c6ed5b2625d..15f76105d7d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.mdx index 74cfcc30b58..27ddaa3874b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index fcd14f20987..9672668447d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.mdx index d68f81dbf3d..c996640f042 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.mdx index 16b8ec132f9..6195ac5e035 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.mdx index 44476a76afe..434d1459cad 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.mdx index cdb3fbe28b7..a64920d7053 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 730e39ed072..13edeea8621 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.mdx index 44ef970b145..76b52e6644a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.mdx index 1da896ceb91..5b4b9affbc3 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.mdx index 746ab75f727..daaff9afbc4 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.mdx index 155fa9aeaff..d71e2d237c4 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.mdx index dfa3423bac2..6ad85175979 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.mdx index 099557b66a1..670788d5ed9 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.mdx index 5e87b6d2615..0d921851b52 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.mdx index cec4257a7b6..cc01ea178c2 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.mdx index faf96c659f4..4da7b6f9376 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.mdx index fde8e974a6f..0a95ab5aec0 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.mdx index 97c950783d8..15172ced512 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.mdx index 51b1e6eee7a..fdba0b78054 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.mdx index 4a219e1b469..0047c4df28c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.mdx index fe45879ca36..28c79099ae3 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.mdx index e176b7b65fe..6f62a06f814 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.mdx index 25f59ec85e7..9aa08f21880 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.mdx index 70afdcfad46..e81c53981c6 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.mdx index 12edc3e73fc..1345591db8c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.mdx index 92195695d1d..ebb760a249d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.mdx index e26101ada5b..b8e9c4c6a0b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.mdx index 1b80780b51c..0756830fa0c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.mdx index 4e15fa0d31c..b9d62bd9678 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.mdx index ad0736c2af1..67bf0ef7606 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.mdx index a7fdc74dca2..b08721d8742 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 903afc4c435..4bfcec0799f 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index dcf0b10bfc8..138175fd627 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 82acd47d2b2..ee19366191a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.mdx index f30858525fe..c60ad20d60b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.mdx index 6763cb97247..8511a8a0fa8 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.mdx index 8caa38d8dd9..2944ae4b914 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.mdx index d047bcc2057..8fbe5d18496 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 6f666f7644e..3d3fdbd11c7 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.mdx index fa6f4d9c84f..663877c2891 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.mdx index f2294eb6556..0ad50012cbc 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.mdx index dc5b010f81c..b121b1e1234 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.mdx index 26890742e0a..7f9e04eb458 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.mdx index 63cdde00bb0..7f24b45f0bb 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Estimator base class. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.mdx index 0989924fcaa..b7ff3a6ec1f 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Sampler base class diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.mdx index 6215f29ee13..bafa6ce7608 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.mdx index bbd9b42f9f0..bd77c2a48e0 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.mdx index cc47e0c14c1..8d68fd03d96 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Sampler class. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.mdx index e79f7762790..c7e83d31dac 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.41/qiskit.providers.Backend.mdx index 887f1859eea..a722474411d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.mdx index 1c0ee251000..b4c0d7c1121 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.mdx index f3e0d94bf8c..10ac94acc81 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.mdx index a7f331e06f9..14ec853a6ed 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.mdx index 89498edcdd4..f568a1fec3a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Job.mdx b/docs/api/qiskit/0.41/qiskit.providers.Job.mdx index 64ab49b2f1f..da8f09fb4ea 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.41/qiskit.providers.JobError.mdx index 04707cbe24d..47ba2977096 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.mdx index 0cfaf9b16b3..08137bb31d6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.mdx index f9ee888fed4..4806d5aba83 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.41/qiskit.providers.JobV1.mdx index 6eb369c4710..96a08f05f51 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Options.mdx b/docs/api/qiskit/0.41/qiskit.providers.Options.mdx index f5e5399003e..35425d604c7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.41/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.41/qiskit.providers.Provider.mdx index 5253ceb47a4..795171f3d79 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.mdx index ba2cf7bb355..cd2201e3ba8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.mdx index feff4c88e54..4501280e380 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.mdx index d8845e14628..6b836ac36a8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.mdx index cb4e32934a1..c713cccd06e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.mdx index c231aef7448..697c4dd1b3a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.mdx index 767dba44240..32556f1c6fc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9f71ccae670..ef1dc3666a0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index d6117097e48..aaf72892372 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index c75640861c9..bb50a8474d8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 3e4148932e5..1185d7e03bb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.mdx index 9f8bb6fdf7c..a7620da06ad 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.mdx index 9aaac799421..707eca9d8b6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index 63c687d80ca..be123945626 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.mdx index fffee430ac7..413dc1c34ca 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 2c6f1ad1be6..ebd7d9296d0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.mdx index 91a3a1f5935..9be4117ade3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.mdx index 20a26adac14..1ad0fd55d28 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.mdx index 9cd0fb9f07d..f93889056fb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index 3cac7353c03..5361fe78fc1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.mdx index b92c97fc251..5add323142f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.mdx index 0b578b3e5d7..57887cf63db 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.mdx index bb1c6c95ec2..eee23267e01 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.mdx index d8c5a078f4a..e50ff954b4d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index f3a77d4d519..57d76efdced 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.mdx index feb0307e877..a6d7f9ced96 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 0326b7cfaa4..cfadb5beab8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 5b6d073d20b..737679044b0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index afeb804a56f..984fa26b64d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.mdx index 662d6868d85..d845beeac02 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 028aa7423f7..4a71fc6550a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.mdx index d2646864f39..54cd4acad53 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.mdx index 3cc61b467a9..99a77c4ae26 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.mdx index 41237f4bde5..ad30400150b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index 2844c7b2781..7b0790e2ad3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.mdx index 9f1f4ddbdf0..63d78e8ee2e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index f5b5ce1a1e8..5a1dbd50162 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.mdx index 998b44ea7ed..35b0901ff3e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.mdx index 92fd3dfdda2..fb5dd96fe06 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.mdx index 65f7731e190..4eca354e0b9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 003fe202e9d..50d4701df7d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index 52736e02a9e..c01aa44aaa3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.mdx index cb9ccd58f13..dd22406b6f8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 7553c20ed91..86f54bd55e0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.mdx index 3d292daa1a2..151fd3179fa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 1271bb54e36..b71c58c05b5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 275ee9eddba..d4430c413ba 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 40620bc981d..7c71ba09e95 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.mdx index 6539bf8545a..0ac4a7edc9c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.mdx index f3f155e45c8..348c58f1345 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.mdx index 3407a477e37..3335d0805b8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.mdx index 872bebb3431..8e0aa38669d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.mdx index 6d1f82c473d..5a03fa1a04d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.mdx index 62d24c9d73f..1cdac9aa927 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.mdx index df21c601ba3..eba394c76d5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.mdx index 90f1b4a8bc2..715e059adc6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.mdx index d106688b810..af49269b156 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.mdx index 9311d88aecd..05ae3d3cd92 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.mdx index c29f68c9c44..20269ab2ef0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.mdx index 12dde2ae5ed..25e03c8c755 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.mdx index f1a41cc718e..a186c520d48 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index 50cc8423f55..16a2f8af201 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.mdx index e41c60a71ff..e697edc6427 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 915eeeb7fb3..f6156ac6058 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.mdx index ddcbc95c712..2906e3acb33 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 17d3c3788f7..6010ccbe445 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 219a79b5e10..070fbf76859 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.mdx index 09f7c3051e4..ce74d6e3568 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 6fa94081348..4b733a71b72 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 7fba5b560a3..5bc008a933f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 28926314ca4..a25e799fd3a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.mdx index 8e4380d66a1..a5ef40bb657 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.mdx index 0147cce97bf..db5e649080b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.mdx index 982973b4a00..fae2b4d5b1c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.mdx index f7a52d282af..f889776b2eb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.mdx index 112817a89d2..f8861f01f4c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.mdx index 570cb6261aa..fe88bca415d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index f02e6d8f239..96b4886b769 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index 477b90dae73..67bfb162735 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.mdx index f49411bb985..6118766e2da 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.mdx index ebfc93e81c6..ab1a3c003ec 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index a66a9c08abe..d41796fe10a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index c5b88b5d511..fdc620d168d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.mdx index e7acf63d7a9..5600cb044b1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 77ca0994801..f2bff1312df 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.mdx index e276416aa4a..3f8dc4695a7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 6e0f2248c5f..d2246add54c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.mdx index ba28bd56585..424a0e85056 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.mdx index 300832db14a..10166e13b0a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 14669c66d00..70270962d9e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.mdx index eb67cac5985..d7317750161 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index c42c209f613..12e7c66784a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.mdx index f8809936589..faa2ae194f7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.mdx index bc82abbad06..dd665d8b3c2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index bbb8eba4dac..81d85530a61 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.mdx index 705c086ea10..b2a6a41dbb9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.mdx index a6708774a2d..b1ebacdbcb6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.mdx index 57163731369..2fad8d20670 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.mdx index e9faabb6245..e030ea3593b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.mdx index 176e11e63f5..f2d200ac129 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.mdx index d220ecc7f2a..86815a26e11 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.mdx index 64304d6d2d7..64a68f23162 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.mdx index a8bdf0c2d4d..acdf9a76e9c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.mdx index 77350f9f9fe..a744a8f40c3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.mdx index a7d4b963123..bfed5a126a0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.mdx index 24521e5440b..e0780e70ea9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 2a583cffca1..c8886b4133f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.mdx index 37cf3c9bc6e..078c8fc6ae6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.mdx index f072a12c718..b91f2a56127 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.mdx index 64d3cd2b706..e0231631a42 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.mdx index 8ec124133cc..32022e75e3b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index d283318850a..8929cac8fbd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 972fbc7742f..35f9633db94 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 12e07e8e2e1..909503199c1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 678b6f00d34..12ffb9c86b5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.mdx index 355dda7c778..fae48ed5f9e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 8201d028ab1..f80093863fd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.mdx index f1a92da626c..457f6df32fc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 9dec97ce7c6..76cf079caec 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 64db4647870..d25cf2cec91 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.mdx index a8b3c7fcc99..4727f72b433 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.mdx index 3b860da157b..dd5f672858e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.mdx index a351d4a7de6..3d440dbd168 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.mdx index 25725289525..a799a22575d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.mdx index df680555a43..44853a77532 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -45,7 +45,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -208,7 +208,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.mdx index 82899e264c1..80738d94f55 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.mdx index 556a1662fc6..7e71921a93b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.mdx index fc2441800e5..12e05665abd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 140ea22b29f..898906a852c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 5e3aedfb95c..1a7f4ba11cc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index dcd14e43748..603cb4925ec 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index a0621ae2a94..c1bc978f338 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 6c5a71cae4d..df0b2502e74 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index c83428a2780..9174dc99629 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 2161c2ac7ae..a57a3f0beb7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index ca71a7db4c1..f40a42896a9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.mdx index a9565716139..894d26703a4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.mdx index f2d2d7dc516..7d16080d5f4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 9eb71ce8498..a3fd47696e8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.mdx index 3896d64d987..58ed8123c32 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 9129540958e..4450de7b763 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 205b3c946dd..de88fb0db2e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 5a018b1ed6a..fe440db4c0c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.mdx index 2b95d5b8901..fb6ce7e6a0d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index e3feea1c9ed..2f4afaf6880 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 6141fc50d55..fc00914c5bf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 21593014028..bf727b05988 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 34adc37569e..25ce03d8040 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index fdbec51a7d5..bf67962a9b6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 1130cc1ac5a..280d5b99fe0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 0c184157ab5..5f1232151ce 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.mdx index 4a3398fd80a..f326a03ffee 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index d570e790fed..e74ba210f9c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.mdx index 2332f1b70d3..bdc5980ab2f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 04ffd895e83..744269571a6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 2b4f9f5ceba..d3d729835aa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index c81dcab7b6e..4353eabfebf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -35,7 +35,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -131,7 +131,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 2c33cc5299f..1e4d7ea621a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -38,7 +38,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e86956257b6..831b12153f1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index c8fc29189db..448d6998b89 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index d6cdbcae855..4629983891b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 0f8e57ab2b2..0b257d25da3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 191af7e544d..72fd7d58e27 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.mdx index d669f56de4d..2c4301151e0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.mdx index 5d433caad00..c21da4a2ffa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.mdx index c9fda81e9a4..80a4315aa25 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.mdx index 7bb78b0a4e4..646ea3a3d07 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.Command.mdx index 65a4ea1db89..a381c5bd743 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.mdx index fd1bafd2ddc..64fae73c04b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.mdx index 570a87099d3..d1d7bd5223c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.mdx index 5d1bf50f811..d00725777b2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.mdx index 948ebe38e0e..4be8c157b3d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.mdx index 19eea837992..f08a9685936 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.mdx index 41101afc93a..d711cd26c41 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.mdx index 0303bd8125f..a1979b456b4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.mdx index dd54ca2c1b8..137d3f63fbf 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.mdx index ffc2099785c..95f67fe763a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` Time-ordered sequence of instructions with alignment context. @@ -422,7 +422,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.mdx index 4f6d7d4c719..bc861fdb905 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.mdx index a78b5a833d9..6b522537751 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.mdx index 840339c240c..caadfac9ae9 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.mdx index 3c43da3ee95..52872b7349d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.mdx index 4d26850a2c7..4a65499add4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.mdx index ecbc856ac01..e566453acc0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.mdx index 8332d67699a..738a9994ed1 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.mdx index 1317b7b6258..87ed9849d31 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.mdx index 7eb3157cdb3..ee70120393d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.mdx index 2ea378c66f3..4b1d7c26ef5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.mdx index d7a924c14be..f407b06dbe4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.mdx index b34ac806d1b..4ca527d4343 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.mdx index 4268b6a9d23..789ea2c0663 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.mdx index d668e6c1bb5..1413f530f2a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.mdx index dd823d5974d..d80b914f9a9 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.mdx index 16b8fad4a74..f749ae9cc07 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.mdx index 5ae68cdd0c2..209270d3543 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.mdx index 92695d32e71..361269b515e 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.mdx index 3fc2bbd5a05..c8bb9586554 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.mdx index 6163dc7eda2..cf638b3550c 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `object` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.mdx index fa2663be2e2..e02dcf56fd6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `object` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.mdx index 6045ee6973a..ba419a51dbf 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `object` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.mdx index 55e3f8c321e..13e9e688e63 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `object` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.mdx index 3b2e98df065..c35ebad5abe 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.mdx index 6cd51698489..eb71994c479 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse # ScalableSymbolicPulse - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") Subclass of [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse") for pulses with scalable envelope. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.mdx index b27156a30d3..f52b2bdcf97 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.mdx index d6fd9207a8d..8f22c7252d9 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.mdx index 699dab9077c..af0a0c3e1b6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.mdx index b60836b72bf..58862c18439 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.mdx index 3af254d7186..49590b6b3f6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.mdx index a52eef945db..3eba1d49adc 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.mdx index 46b0d55099d..96a8a1df936 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.mdx index e9f2be669f8..c7729c6cbe5 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.mdx index 3bfa2b53908..e816cc0d70e 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.mdx index c8873e06066..93833363baf 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.mdx index 05dce2c03ac..16b5ea61e38 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.mdx index 7e00f4c2407..8504807c2ba 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.mdx index 5b7e9a61f6c..d74f9f7ac6e 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.mdx index 4c3c320848d..19cb26de112 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.mdx index 8cfcfc082c5..2161c764599 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.mdx index 3998a8d6554..8e5c04b0613 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.mdx index a9db8f63a66..5265726f3c4 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.mdx index 2b756385b12..fb6c7ca4e46 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.mdx index 9dd6329a0ce..45439cbd3e5 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.mdx index a95788c6ed8..4bd63562087 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.mdx index 071a2701bfa..2ad387eadf8 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.mdx index 01ef04221d6..d6e04ed3dbb 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.mdx index 5511bde7f4b..c5ca81a51c1 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.mdx index 8c04d759ac6..0b325fff1be 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.mdx index f84c4c7897d..f0cfb72ecc3 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.mdx index 55e79ab2d96..741f8a34430 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.mdx index 919aa33c873..7a10fd7c458 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.mdx index 0080959e8f6..5d746d8c0d1 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.mdx index 67c78e5acf2..8eda984804a 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.mdx index 1562284cc6b..9a6af1ed2c7 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.mdx index d77c2417850..b7527c6bbdf 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.mdx index 2d2eb8acb37..d1ece396842 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.mdx index bf91e0c7923..c6d287f7409 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + 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") An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.mdx index c8c2ed8400b..11043b65cba 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.mdx index 36d9bfb36b0..73840d9c9b5 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 57b38f236a2..5a8088b7ffb 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.mdx index c41c26cfd8a..82d1ba81b58 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -181,7 +181,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.mdx index 2d5851a795f..42c1ed023fd 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.mdx index f1d00e7882a..a70d1e15bbc 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.mdx index 4f9ed7927a0..6a5c3e587e0 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.mdx index 17baa7b1c1e..8e00bef3e0d 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.mdx index aa082bf87f5..00d28a88640 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.mdx index 2eac1eb97fd..57228f22ae5 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.mdx index b435a7683b3..d67c69b9753 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -269,7 +269,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -305,7 +305,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -331,7 +331,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -612,7 +612,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.mdx index ef576b0c0fe..e556be6cf9b 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.mdx index c5c19047a7e..5420750b1e8 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.mdx index 989671bc638..85bd3819d02 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -191,7 +191,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -215,7 +215,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.mdx index 26f1c11678e..fd6dac8a387 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.mdx index d5fc59f33e6..ad7ff0f3ef1 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 0290cf2e18c..c080d00f368 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.mdx index fe9ab6a3552..f6882ee1f2e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.mdx index d2d70407b76..c5ac7d03f69 100644 --- a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.mdx index d74bca8f076..ab06ba79062 100644 --- a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.41/qiskit.result.Counts.mdx b/docs/api/qiskit/0.41/qiskit.result.Counts.mdx index f7a11750401..85aa945e454 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.mdx index 2638218f164..a287ac90e77 100644 --- a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.mdx index f8587dc2022..adbd050728c 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.mdx index f551d88f8b5..b733a988051 100644 --- a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.41/qiskit.result.Result.mdx b/docs/api/qiskit/0.41/qiskit.result.Result.mdx index 8cd4bd877a5..7d42e5a0137 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.41/qiskit.result.ResultError.mdx index 0f55fbc6dc5..bfe69c22116 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.41/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.mdx index 119b2bd18e7..819946bc691 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.mdx index a80fbe0d1dd..bdcc28f39ed 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.mdx index 98daf53fdcd..f26b7876933 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.mdx index 0d4eea5fd12..bdeba1f8653 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.mdx index b594f084085..0148a3733ef 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.mdx index 39ce5453758..9e7e14d78d0 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.mdx index c6fc0c5e9b3..b069c90f0fb 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: `object` The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.mdx index 706e27d2336..0eb5c1d4d2e 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.mdx b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.mdx index 3b3fa54541c..8f6081944cf 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.mdx +++ b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.tools.events.TextProgressBar # TextProgressBar - + Bases: `qiskit.tools.events.progressbar.BaseProgressBar` A simple text-based progress bar. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.mdx index 295a631c7e3..c25a853a7b0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.mdx index d9b8db1d080..bfcd4875876 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.mdx index f4fafed070a..4c5daa88516 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -93,7 +93,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -189,7 +189,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.mdx index 7c6eaaa2c77..7fe570a3365 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.mdx index de1cf4ae53a..4d71f3c4e45 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.mdx index 87a7baca575..be1ee7ccad9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.mdx index 0c0c6845a02..400a1a199b9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.mdx index e60070c007f..95853a37c17 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.mdx index 33049c65c94..d40c042d370 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.mdx index 68a9f321f05..fa691ccfd2b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.mdx index b953f4dc664..0421780217e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.mdx index c94346776a4..6f3feaed451 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.mdx index 4c017f30d6b..b488ff3dd1d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.mdx index 35739d214ca..ebf2caac722 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.Target.mdx index 10fd5e19eed..bcd7d2422b8 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.mdx index 7b874541f8b..404c67f794d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.mdx index e50155d6d53..289487edf1e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.mdx index 233e82112d0..d275823660b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx index 1597a6f9dd9..5774cca2726 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation # ACGSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.mdx index bc709e8cc66..e7cfd7d5246 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index cde990b13e7..0b3da63f960 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.mdx index 906fec4bf10..5ffc984c924 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 0be306576d5..de1ee66d540 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.mdx index 4809dd56583..cf83adbd9d2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.mdx index 57ed49629ba..a017b5a3baa 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.mdx index 594fa0babff..f388f968c0d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 0ba6e2c79e8..8f301cbc76b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.mdx index 5ee3f4a567e..3c8eb8b03f4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx index 5db3ac502f5..7c28bae90b9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation # BasicSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on sorting. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.mdx index 7dc4127f258..f1c25993fd9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.mdx index fbd71707caf..1b5d61ee526 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.mdx index 6187966727a..b7188f59afb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.mdx index f7d5ff0cad2..913e62f0dd3 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.mdx index 9579802bfb9..f9ff2fa3cdd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.mdx index c8c11c626a5..2fd03a955af 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.mdx index 16240158f20..9281a2a1ae0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.mdx index 4dea17057da..076f57e3b7d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.mdx index 4f71419a922..ded7ce800d7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.mdx index 231c0c150bd..aa7cff5c360 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse # CollectAndCollapse - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A general transpiler pass to collect and to consolidate blocks of nodes in a circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.mdx index 0ef475ae766..3b03c862f69 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 94ca530af82..9bcf81db622 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index fa7b1410cb9..4dfadb3178b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.mdx index 3c8a2747d4a..e2817a37433 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.mdx index 55fc184cb7b..1fa6fa0906d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index d49dc963659..aa70816931c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index d1112cee107..8a423f2d52d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.mdx index cb9bdc5c269..796d8a473a0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.mdx index d1c4f9cf4d6..5b81043d765 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.mdx index 3aa30179981..09d7410423d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index 22a08f88511..26339c37b94 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.mdx index 0b0c96d80d4..b4baa215462 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 1127044f7fb..5100f430c1b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index f4d3c084d45..ba208ba832e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.mdx index 5e40ee4a25a..d5bbf8a8580 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.mdx index 902690eb354..5d460defe28 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.mdx index 32b1363b096..f26ebf56a95 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.mdx index 12d14cb6153..ecf8d895d69 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.mdx index 450217a6960..6da6a3723ab 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 7b44fe8a0f2..44b9207a10d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index c3947931765..1e88eaa13a0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 28831351b0f..5a41e9fd749 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.mdx index bfcd5062daa..d9da55beacd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.mdx index af229585b87..4cb66d992c1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + 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.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.mdx index 3ddf9b6ee2d..6045c78cf5d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.mdx index 84d87c44090..666b5bf21fb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.mdx index d006d8246a8..0dfa82d586d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects by choosing the appropriate synthesis method based on the object’s name and the high-level-synthesis config of type `HLSConfig` (if provided). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.mdx index 0e739707668..0bb19292c57 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 9480119c285..a835c0ec273 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.mdx index 741e921953b..2d4d5ad9fb0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx index e3f207a075a..342a7bbf670 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation # KMSSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.mdx index a62fe11e77f..c030197a8cf 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 7a7e5818fb2..14a2c4b737c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index b7c9234b174..f1cd0eab785 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.mdx index c3e27c863dc..e9c0cc4059a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 3182cd3777d..d52f18cd0a1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index c7e5b614b6d..8b62a9f6e60 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.mdx index 1e841e85a91..c54c3061276 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.mdx index e2bd342f9ec..5665d883f5a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 62f8ab0194b..f98e0f3f990 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index b1dd28ac13e..7dea352de1f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.mdx index 5478fc11ba9..d5d406991ef 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.mdx index 7592bfa780a..662392749a4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index aaf6d07f71e..b7e877d8ee9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.mdx index 8b60d53d0d1..d713d5b59b2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index fc85672d1d2..9d568aa5387 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index d75cd8c4a11..29f2b746f7e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.mdx index d3d36989df8..9e3f7fb8762 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index e8a7acab4d9..ab75f601ad4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index d4c5c3a31ac..1dbd59ac1ee 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 98e77a93fd9..bb8819a0b0b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index bfbe5f210fd..6372c24337b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.mdx index ea2eb2f8599..32905b1fa94 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.mdx index 5fb5a722ddb..a810c55ade2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.mdx index 3988177a07d..222968918ce 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.mdx index cb0d7a736c7..4be4c915a5e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.mdx index 3a8e2d07b2c..1738eff74d2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.mdx index f854432eb9b..667c1b283f8 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index 8c0e3481fb0..ea94cf57e50 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.mdx index 57a91748a57..524dbb507ba 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.mdx index 354c1e8beb4..a5b7a41bd91 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.mdx index 6c7d4a74da3..0e7025499e5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 6488016c10d..250d5010291 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.mdx index a922a0c6a1b..1f02df35170 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.mdx index d4d334d9bc0..61fe06da331 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 2ba00ef143d..b7a4e90b523 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 90dc272f476..32b3af62390 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.mdx index 7b5ff13427a..a4eb84695aa 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.mdx index 2f0aa847253..c7398b0c8c2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.mdx index a0d38b3d6b2..489cf843383 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.mdx index a30fe7a491f..40e3153cc9c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.mdx index 1cbb4d742df..2824602612f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index fc04d692403..8802aeeab3f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: `abc.ABC` Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 362a790d3e1..5cb13d69755 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: `object` Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 875395beb27..d810acb27d7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 53cc8283379..119faa702bd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 2e500eb86ce..3c7b4bef63a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: `abc.ABC` A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 2d0155cc7ab..360846da1d9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: `object` Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.mdx index 91e1508c3b0..6e2016852ae 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index e0e8281992c..4535a7f247c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index aa9d0b15df8..852671cd919 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index a74edbfc470..6ff295914ab 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 8d2f82c9355..09fe9ea6825 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 5dc1b341636..ea797281119 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index e8ac95e07f2..082dfe8f221 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index a2498d18465..c9e6d378d5c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.mdx index 36918667cfd..ffabd6a6b2b 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 83076757d9d..eec601dcc6d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.mdx index e39835bb1f5..b468b72b51d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.mdx index 4d55d258b3f..329da8e7312 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.mdx index 454f978b1a9..00f178bdac8 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.mdx index afe1fc6c6e5..7ad18446ec1 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.mdx index 389188a0250..b42ea8c80ee 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.mdx index 631ef20b2ce..c9deaaa23e2 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerError.mdx b/docs/api/qiskit/0.41/qiskit_aer.AerError.mdx index 66c4e13cd2b..bc4246fecc5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerError.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerError # qiskit\_aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.mdx b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.mdx index 83553fba283..6cb35b4e67d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.mdx b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.mdx index 15d0c1cb5cb..2219e89640d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerSimulator # AerSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -248,7 +248,7 @@ python_api_name: qiskit_aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.mdx b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.mdx index 680f89325c6..3e7dcceae53 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.PulseSimulator # PulseSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. @@ -138,7 +138,7 @@ python_api_name: qiskit_aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.mdx b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.mdx index 4f05cb95811..e6c5dacfc60 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.QasmSimulator # QasmSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit_aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.mdx index 602245254bb..0669453ecc0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.mdx b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.mdx index d5c4f6adbca..ae9e1706729 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.mdx b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.mdx index 762da4cd279..83aa4047886 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.mdx index a684e03f988..b7e2ed0c8e3 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit_aer.jobs.AerJob "qiskit_aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.mdx index fff68b1030c..2900c0ef3a2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.mdx index 33867082b15..48bb57671e2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.mdx index 1eeffcceaac..ddfec7ecbfb 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveClifford # SaveClifford - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.mdx index a573e0dd34d..696b0328e4a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.mdx index a0cae095623..adfb60ec571 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.mdx index 41255c0b849..814ec8983d6 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.mdx index b5c561f77bd..7bb6558048e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.mdx index 617333d68de..61e1948f982 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.mdx index 4b239d6aaa2..1e6d7c9cc63 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.mdx index 8bf1c42063f..9235a1cd97d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.mdx index cac840b6e6a..697d54192c3 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveState # SaveState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.mdx index 10a521d27f8..0b95d90c52b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.mdx index f5a2c163c9f..27936c46f01 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.mdx index 60b37afb883..e02001d6bf5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.mdx index 4616d4a2d16..bb9fa1a0d58 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.mdx index 4d962939f50..12266c6a1de 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.mdx index 33459bbd404..ca7194f7e25 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.mdx index 7c0eba827d9..691a9e128c2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.mdx index 8a41e86a152..cb0bedb8eaa 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.mdx index f186339b0a4..ed90972fd70 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.mdx b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.mdx index 77bb1106ec9..84c725b3447 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.mdx index 87c57b791e2..6c9f6ce6030 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.mdx index 9b5e800c182..d6cec2f7b7b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -182,7 +182,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -246,7 +246,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.mdx b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.mdx index a15e72a3852..5f29c8b940b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model @@ -225,13 +225,13 @@ python_api_name: qiskit_aer.noise.QuantumError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.mdx index ef158325eed..9fb446a87a0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit_aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.mdx index 82df333c7d1..c463b06bb87 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.mdx b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.mdx index a41197f2f2e..8cd420df35b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Aer implmentation of Estimator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.mdx b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.mdx index ca7b7e22209..ade9ee41ea1 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Aer implementation of Sampler class. diff --git a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.mdx index 91f245d5657..ac71eb491c5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.mdx b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.mdx index 39b4cdbee86..6c0a7a8da02 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector # AerStatevector - + Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") AerStatevector class @@ -189,7 +189,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -213,7 +213,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -239,7 +239,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.mdx b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.mdx index b85d4958bc2..ee89f97a5b6 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.mdx +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer # NoiseTransformer - + Bases: `object` \[Deprecated] Transforms one quantum channel to another based on a specified criteria. @@ -49,7 +49,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### compute\_channel\_operation - + 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 **Parameters** @@ -82,13 +82,13 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### fidelity - + Calculates channel fidelity ### flatten\_matrix - + **Parameters** **m** (*Matrix*) – The matrix to flatten @@ -163,7 +163,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_const\_matrix\_from\_channel - + Extract the numeric constant matrix. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### get\_matrix\_from\_channel - + Extract the numeric parameter matrix. **Parameters** @@ -245,7 +245,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer ### prepare\_channel\_operator\_list - + Prepares a list of channel operators. **Parameters** diff --git a/docs/api/qiskit/0.41/utils.mdx b/docs/api/qiskit/0.41/utils.mdx index f21ff8c8ce0..ac6439fa39b 100644 --- a/docs/api/qiskit/0.41/utils.mdx +++ b/docs/api/qiskit/0.41/utils.mdx @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -151,7 +151,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -218,7 +218,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -232,7 +232,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.42/pulse.mdx b/docs/api/qiskit/0.42/pulse.mdx index f11bdad5cc9..479e12f77c8 100644 --- a/docs/api/qiskit/0.42/pulse.mdx +++ b/docs/api/qiskit/0.42/pulse.mdx @@ -69,7 +69,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -677,7 +677,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.42/qasm3.mdx b/docs/api/qiskit/0.42/qasm3.mdx index dac94f66d3a..d2acb3c21ee 100644 --- a/docs/api/qiskit/0.42/qasm3.mdx +++ b/docs/api/qiskit/0.42/qasm3.mdx @@ -61,7 +61,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -89,7 +89,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -157,7 +157,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.mdx index fcc057fd2da..a150f2d4fcc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.mdx index 94d9f94e629..c299ad6b322 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `qiskit.primitives.primitive_job.PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.mdx index 216c9011788..36fbe448b36 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.mdx index 20a7e00583e..9ea2ea96c6b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `abc.ABC` The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.mdx index 083496b6509..790a6501355 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -49,7 +49,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -70,7 +70,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.mdx index df24cf5d962..4aae1dbc54c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.mdx index 638fb02ab52..405dae3fd01 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `abc.ABC` The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 594fb796231..bc0dfdb74a9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.mdx index 1af65c9222a..751bc7d32a6 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `abc.ABC` Pending deprecation: Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.mdx index e2835381ff0..7d3f565ce26 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Eigensolver Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.mdx index b2ed17124aa..43bcbac10c9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.mdx index 763dddac27a..653e2281299 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Pending deprecation: Evolution problem class. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.mdx index 08b5d565951..0c420e1b810 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Class for holding evolution result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.mdx index de725d4facb..ec39e6f9e7a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 5fea03f3607..5a7e09b0c2e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.Grover.mdx index 3710a223992..47a89e1fab1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -138,7 +138,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.mdx index 7d1e3afeba6..c8668c82934 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 625f6e90353..565bb20d9a8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index df6068f2148..d50f7143208 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.mdx index 8051ba3551d..16f7f34a45e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Imaginary Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.mdx index d36dd10c45d..988c87c9614 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 27171f5bbc8..a9d668dbbfa 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 7bc493401ee..5bd38d54a6c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.mdx index 8ba24fb4f64..a4a28b59b04 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index e086007ef84..3d376734646 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index af245beb807..37c75b67fb3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.mdx index d6d18b4c2ee..38b676a7951 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` Pending deprecation: Minimum Eigensolver Interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.mdx index 3c0774e3cd0..528e5a412b1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Pending deprecation: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.mdx index e37e683c0f4..b2392c2f12f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: NumPy Eigensolver algorithm. @@ -49,7 +49,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.mdx index ce6b495c8dc..9d64c716650 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Pending deprecation: Numpy Minimum Eigensolver algorithm. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.mdx index 35468ea58d8..7c38520c89b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.mdx index 45403348844..d6ce20b1c84 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.mdx index 96ea2987d9a..b4727d7bc98 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.mdx index dfea8bd1b22..8f657b3f7fd 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.mdx index 8b6f88681eb..7bd698eddad 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.mdx index c4e2fff95d4..c470adb0713 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Pending deprecation: Quantum Approximate Optimization Algorithm. @@ -143,7 +143,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.mdx index bca635059b6..538c8c0fa39 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `abc.ABC` Pending deprecation: Interface for Quantum Real Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.mdx index ac1400cf747..a30eb97df2a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: `abc.ABC` Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.mdx index c16e488c430..982009945b2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.mdx index e33d71b945b..2793b7e1e4b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Shor.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.Shor.mdx index 4f2adc3dcca..7356036beae 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Shor.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Shor # Shor - + Bases: `object` The deprecated Shor’s factoring algorithm. @@ -75,7 +75,7 @@ python_api_name: qiskit.algorithms.Shor ### modinv - + Returns the modular multiplicative inverse of a with respect to the modulus m. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.mdx index 64ccac962cf..e1bc4bbaccc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ShorResult # ShorResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated Shor Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.mdx index ad8e45deb12..d2bf61d4835 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: `object` Time evolution problem class. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.mdx index 62815763fc9..998e627029f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.mdx index 73044eb4424..37c23e39399 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Pending deprecation: Quantum Real Time Evolution using Trotterization. @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.VQD.mdx index 7f0c0c52698..cbf787a1652 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Pending deprecation: Variational Quantum Deflation algorithm. @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.mdx index 2ba324c6bd1..5012f675181 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Pending deprecation: VQD Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.VQE.mdx index f3fb7b24a7e..2b367b36f25 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + 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") Pending deprecation: Variational Quantum Eigensolver algorithm. @@ -173,7 +173,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.mdx index 3e164e6e78c..c4720635c47 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + 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") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.mdx index 61dcbc840e5..0137bce72ce 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + 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") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 6c0d0c9ce20..afe96d38acd 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: `abc.ABC` The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 0c0a55598ac..98a25b5183e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index 0103c9133b6..5cea3155460 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index f368547f466..09ea54c2876 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.mdx index d4af35c20d5..ea6094d31fc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.mdx index ed2264846b2..b77f9a3d40b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index 4b72b5603d7..07c3f315d62 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: `abc.ABC` Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.mdx index d41c027ce1e..75d9cf88d75 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: `abc.ABC` Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index b3235c8d4ab..c65b751852f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: `abc.ABC` Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.mdx index 8656e43fe6a..b2fc5873f36 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType # DerivativeType - + Bases: `enum.Enum` Types of derivative. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index fa76385372c..6b1ac8c4403 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: `object` Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 4aba2bdeb66..90a872db23a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 10f9789ba1c..a373548f57e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index f64d1d0a977..2ef6d638d1c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.mdx index 12d9c32518f..1cd13c9349a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index e00c578362c..20ed9e178e7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 4b201c06686..6975b2bdd98 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index f960cf50fb7..85020bb55ba 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.mdx index 0a69e89764b..68f49539393 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: `abc.ABC` Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.mdx index 30ed7476a0e..55a7dc1ceb2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: `object` Result of QFI. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.mdx index 1dd207a6330..15b0d015475 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: `object` Result of QGT. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index c629ccf338e..d20a511c8d7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.mdx index 0fe092089e7..07a44f43345 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 79f0e146dce..3e70517f956 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 0a40ab008df..8b898ab7920 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 0287233ec48..9ac275b1d81 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: `object` Result of SamplerGradient. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx index 1714901e627..e96d1a83ef3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage # AbsoluteAverage - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated observable for the absolute average of a linear system of equations solution. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.mdx index 950b1d17b2e..fd0f757e0e0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL # HHL - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") 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. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.mdx index c624e2884f4..b26fef487b8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver # LinearSolver - + Bases: `abc.ABC` The deprecated abstract class for linear system solvers in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver ### solve - + Solve the system and compute the observable(s) **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx index 132ecbd7f37..54cf3b406b3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult # LinearSolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The deprecated base class for linear systems results. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx index e3eb226dae9..8ac80187af4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix # LinearSystemMatrix - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` The deprecated base class for linear system matrices. @@ -231,7 +231,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -341,7 +341,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -351,7 +351,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -442,7 +442,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### condition\_bounds - + Return lower and upper bounds on the condition number of the matrix. **Return type** @@ -1043,7 +1043,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### eigs\_bounds - + Return lower and upper bounds on the eigenvalues of the matrix. **Return type** @@ -1159,7 +1159,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1178,7 +1178,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1196,7 +1196,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** @@ -1968,7 +1968,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix ### power - + Build powers of the circuit. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx index 3836e96908e..d38ab43c59d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable # LinearSystemObservable - + Bases: `abc.ABC` The deprecated abstract class for linear system observables in Qiskit. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### evaluate\_classically - + #### Calculates the analytical value of the given observable from the solution vector to the linear system. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable - + The observable operator. **Parameters** @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### observable\_circuit - + The circuit implementing the observable. **Parameters** @@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable ### post\_processing - + Evaluates the given observable on the solution to the linear system. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx index 97688660e70..596b2d8abba 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional # MatrixFunctional - + Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") The deprecated class for the matrix functional of the vector solution to the linear systems. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx index 0fa5fdeab41..e6a46367bef 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver # NumPyLinearSolver - + Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") The deprecated Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx index cbca2f3f0a8..cb2120c6084 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix # NumPyMatrix - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of matrices given as a numpy array. @@ -253,7 +253,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -363,7 +363,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -373,7 +373,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1181,7 +1181,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1200,7 +1200,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1218,7 +1218,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx index 58d21549ffb..c2c3c77d2f2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz # TridiagonalToeplitz - + Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") The deprecated class of tridiagonal Toeplitz symmetric matrices. @@ -266,7 +266,7 @@ $$ ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -376,7 +376,7 @@ $$ ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -386,7 +386,7 @@ $$ ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1194,7 +1194,7 @@ $$ ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1213,7 +1213,7 @@ $$ ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1231,7 +1231,7 @@ $$ ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index cf02713dea8..73fb6ff3fbf 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + 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") The Adaptive Variational Quantum Eigensolver algorithm. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index 302f9998cfe..f25c7c3913e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index f96f09d2a65..40d611cf907 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: `abc.ABC` The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index dc045734105..01faeb6cb22 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 92820d78c3d..9bb8d8719bf 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index a97fa61dfe3..6c63d7bd706 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 609a0358b84..408562032bd 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index c5011faddad..4d3faad78d2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: `abc.ABC` The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 4b7020ebb98..fba3cdcf516 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 2ed1b4bbd49..bb25f35028f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + 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") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index b7619ad46d5..4508f354240 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + 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") VQE Result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index 4f1320dd2b5..76e4ae50811 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + 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") The variational quantum eigensolver (VQE) algorithm. @@ -143,7 +143,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 0034289a497..09b0c1a6738 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + 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") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.mdx index 020a9c777b8..6635acdcfc6 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -154,7 +154,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.mdx index 744fbbe52b6..d301d705cb7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -55,7 +55,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.mdx index 5d7496a0400..4799ab66ded 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: `abc.ABC` Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.mdx index add349b3738..665d042f88f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.mdx index e532c4bc8ec..e5ee38d992a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.mdx index cc4280a4753..25485ee61ca 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.mdx index 343768127f9..184270180a5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.mdx index 6dc9619c2ef..ac230122953 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index bfa6e54d60a..1cbf8dca525 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.mdx index a995a7cbef4..099c42126ad 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` ESCH evolutionary optimizer. @@ -47,7 +47,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.mdx index 44f8152f270..6be53def3db 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -74,7 +74,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.mdx index 8a631a9cce5..7736e983f3a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -206,7 +206,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -322,7 +322,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.mdx index b23bd61948b..786db881501 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.mdx index 2903e6ce05b..489178a847e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -35,7 +35,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.mdx index c5aaedce6e5..3b0159dffa7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.mdx index b322d55fdf0..1e06e770ed9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.mdx index 35f2196a649..ef69320b66f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 12300228773..16f9ff4d338 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx index a03cd8048ef..8a02c6f6800 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.mdx index 9cc97fd6242..6852a374bb6 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `abc.ABC` Base class for optimization algorithm. @@ -19,13 +19,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -91,7 +91,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.mdx index ab157755da2..ec1e3924094 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.mdx index e7211db34b5..f50e782c454 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: `object` Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index a4edb07b745..a9f7e48fc94 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `enum.IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.mdx index d5b82e3f1cb..39760edef0e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.mdx index 0c7af90199c..5678dd03135 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -37,7 +37,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.mdx index f5747cc6c35..b552dab6652 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -101,7 +101,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -135,7 +135,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -145,7 +145,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -184,7 +184,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -274,7 +274,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.mdx index 401f7a14def..f975155beba 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.mdx index b8c9de235ef..b21a4789396 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.mdx index 125d3054cf9..befa6de0147 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -163,7 +163,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -179,7 +179,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -269,7 +269,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index cb53fd95b58..17c6812b5a3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -32,7 +32,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -98,7 +98,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 0c1dc4f98af..f17aeff69be 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -102,7 +102,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](qiskit.algorithms.optimizers.SteppableOptimizer#step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -138,13 +138,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -212,7 +212,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -258,7 +258,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.mdx index d423c54804d..5f6b1c7655d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -107,7 +107,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.mdx index 7aee7d3cb6f..b0dea7d33e1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: `abc.ABC` Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.mdx index e6c0c7d4a97..fa4869b3d7e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -90,7 +90,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index cb3d3dcb882..70f558bbf8b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: `Generator` Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index b220fdcecd5..bbdc3f75294 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: `abc.ABC` An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 4b55c613d9d..61f4ddc453d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 620b9e59e0e..327a60ef55d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: `object` This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index c5b51202246..411141e661d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -71,7 +71,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 746b8d467aa..c428243dcc1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `scipy.integrate._ivp.base.OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index 7d325ac0f22..3ffb8a59752 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + 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") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 74cc7ba6268..6d903b31606 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + 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` Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 96a8fca711d..adc6514a3a8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + 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") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index c6d723b1d0c..d9644b6f052 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + 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` Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 5127d402cf5..7681be50641 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: `abc.ABC` A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.mdx index a636d454710..2a90f68c89f 100644 --- a/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `types.SimpleNamespace` Class for Run Configuration. @@ -78,7 +78,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.mdx index 0d2147faf59..06bcbc2a880 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.mdx index 34017d7f758..bd333dccd96 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.mdx index 07d3c857667..049a3c4823b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.mdx index fc2c96836fe..e38f56323ab 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.mdx index 299160f7fef..5c2a74ebaa2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: `qiskit.circuit.register.Register` Implement a classical register. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Clbit.mdx index 9e102befa82..58c40deb7de 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: `qiskit.circuit.bit.Bit` Implement a classical bit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.mdx index 76c163cf855..6a49eebd883 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.mdx index 76e5018d15b..2775f534a5c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` Abstract class to encapsulate all control flow operations. @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + 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. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.mdx index cd5e8933cab..27b93ad5180 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Delay.mdx index b311e194454..9a3937156f2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.mdx index bd635868fa3..712315317ff 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.mdx index d6fbd3fc5d8..5cfb9bba491 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Gate.mdx index f5d240c88da..b11019d9ee7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.mdx index 31bcba675f2..cc14c0159c3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Instruction.mdx index 745946d0f89..91c5c015db5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.mdx index 8620364d28c..ab6d01db174 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Operation.mdx index a8c88a5f04c..20a198f2700 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: `abc.ABC` Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Parameter.mdx index 9d5ec77baa3..6df923bb291 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.mdx index 5c494f026f3..68317381b8e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.mdx index 34f54dac60b..33f0250a221 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.mdx index ac57b853a6c..53d8a54326f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -309,7 +309,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1217,7 +1217,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1236,7 +1236,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1254,7 +1254,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.mdx index b6b094b3a68..2cd8d5699a7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: `qiskit.circuit.register.Register` Implement a quantum register. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.42/qiskit.circuit.Qubit.mdx index 771a50e90db..a7a90bb22fc 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: `qiskit.circuit.bit.Bit` Implement a quantum bit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.mdx index 8befccf2d7e..ee94f32a31d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.mdx index fc87dcabe97..48616f462eb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` The Boolean Expression gate. @@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 159063c474b..5827d52145e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 4ebaea6330b..f33ecb363fc 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 8b3aec0b6d6..5c92c2c3088 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.AND.mdx index 937404c53e2..2a35e4a71d0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.mdx index b17f673c531..19cfa245c49 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.mdx index 3dd9679d265..584dbb1e42e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.mdx index e83bf73b49f..964e1d8d929 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.mdx index b79b4252670..2c7a94ed830 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.mdx index e91d255a553..7b376050fe3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index b1347678e11..16f8ab6d2c3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.mdx index 1a7bd9a26ac..14cbf46e916 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.mdx index 7a6ed46acb0..68b0547162c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.mdx index a497b2fb094..a2b6e668002 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.mdx index ab25c591290..937e6d89832 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.mdx index b4718c3cd4f..eba7b9e4b33 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.mdx index b1cdde0ca62..e8c736e94e7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.mdx index 2a779ea7be2..8a140c410a3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.mdx index 79bb8ad6b99..0d82113e633 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.mdx index acb83741061..df63a5c0daa 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.mdx index 8f8e6a03b01..253ab702558 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.mdx index 2e3f004ee35..c94ea252ba2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.mdx index ff67b7c9e94..91fb1f9790c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.mdx index 73b501a11dd..24c68b88fcc 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.mdx index 352e7f0d0e1..607ac101bd1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.mdx index 4333cdbf6c5..83c8189b796 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.mdx index d768ea562dc..52fe805b30d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.mdx index 6c20f5acc0a..c7c99a537a1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.mdx index ba9e3fb2ea1..b17d731438c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 0c88ee7708a..e4680f46c87 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.mdx index 94c2a785ce8..7e57588b386 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.mdx index a7f877c47d2..06ff09d2b48 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.mdx index a0f60794b5a..693ec2a76cf 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.mdx index 4791fd74b85..66479589fda 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.mdx index 115783046e1..f7512409512 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GR.mdx index 1401219fe36..769000fd6cf 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.mdx index 908fde90246..555c080ba8a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.mdx index a36a65e9c3f..e767afd1216 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.mdx index 332f6b1ae73..0b40d60025d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.mdx index 3aab613a8d0..85119e82687 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.mdx index eb184f0410a..df9fbfe6679 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.mdx index e0ad512f200..bf59561fc7f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 3b75b59d964..5d86c5063b3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.mdx index f18ac374551..7dc8ec5b765 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.mdx index 3f0ccc8241f..35d4bf4fd1d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.mdx index 670acf1e0cd..66ce2ff161d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.mdx index a3e72e25078..c1a48ca7b75 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.mdx index ad8e2595bdf..bcd7e58c151 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.mdx index d573867a68b..362ce2d4a1e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.mdx index 4ec4b9e86fb..0fe5ff9a164 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.mdx index 36b25e3dabe..f725784f30b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.mdx index 85be265bd1b..9dd97dc957c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.mdx index bebd9acd029..f8e5fe71efd 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.mdx index aeaf309cbbc..f6326c90f59 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.mdx index 520350c5d8f..6f812f5485a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.mdx index f4a0555e344..cb5d5db96d4 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.mdx index f8e53c0f1bf..55e095f14c9 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.mdx index 1760836210b..58c3d36bdb9 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.mdx index c0a9b91cc65..6b31b83907e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.mdx index 9ab9a19e660..cd6efe65b26 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.mdx index 9ba16842a8a..6600714fcf4 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.OR.mdx index 378aeb66f8b..0320476164c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.mdx index 331c88acb3b..f8934dbdb1f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.mdx index 4be800193ec..b8914016fcf 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.mdx index 589af1fd7f8..c32cd407055 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.mdx index f15214f48f1..f72fdc926d3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.mdx index c0434ca3a44..14454af61b3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.mdx index 20b9e44ecc0..c5520e003c5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.mdx index d06d3e8c5fc..25f832ebb1d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.mdx index 92ba57ada94..0258f2a1044 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.mdx index 67360f6abfa..421f473f453 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.mdx index 40a5fd132d6..eafc36e866e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 4e4b4892816..0f1d6b144c1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index ed12ee7e749..48ba15a5e4e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.mdx index 2bc8667bb66..335031b5ffc 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.mdx index fb432d018ab..9309ff8db0f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.mdx index 42fa97424b7..70eb1b1e5b5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.mdx index 8904cd09a2b..81fc556357e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -56,7 +56,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.mdx index 7a2146bdd32..43e70ab0b51 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.mdx index b3734648206..861537162ac 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.mdx index 8e995537778..afd4f1ddade 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.mdx index c3b251cbdba..67445af5a9a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.mdx index 7b0cf56336f..0f601750f5d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.mdx index 1468f92abe5..e94e8ee9ab5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.mdx index 96ce8ebf989..accec8f3907 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.mdx index b95c53a6913..c9217b405d0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.mdx index 97daef78b3a..a38a8fcc0c8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.mdx index 572a916ca7b..79f7c57e9c1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.mdx index 0ed04254cd6..70be751a721 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.mdx index 01281b666bb..ba4f81063ac 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.mdx index 0e297b29444..b63a91ef795 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.mdx index dbec99e3d1e..8a60abb84ee 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.mdx index 44fc0fab86b..98cf7a89cbd 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.mdx index a8445d89509..36af6d588e7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.mdx index d366c76dad7..759fb986d13 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.mdx index d83b75de530..ef153c12710 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.mdx index 5be5f7d2c0a..527f197a743 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.mdx index f43889f9622..244ceecab0c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.mdx index 83641ea35c4..113f3543410 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.mdx index a3f0b47402a..62bbe2a444d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.mdx index 9c9df17d31d..7af0337e634 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.mdx index 3b0089774bc..3195276c084 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.mdx index 5838abda1ee..2f812d91bae 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.mdx index 75a36996dbe..de928c02ed7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.mdx index 7fb6dfcc754..326aaf0684b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.mdx index c98e0351eb0..46bb4cae16f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.mdx index f5da8cdf0ec..d4ed01937b0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.mdx index e1199212f0f..8a063a82fa5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.mdx index 9e486975237..0f884c9d84b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.mdx index ea02d4d3075..25df0899ad4 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.mdx index 54bd40c41c0..ed28b89560f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.mdx index 60cc420122a..86954e0447b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.mdx index 2c38c05b6ff..cc7cd7cbf75 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.mdx index fb3378eedb2..d6052249793 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.mdx index a361e31f3a8..7b6e9f4ed9f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.mdx index cbee53a8467..54f9214f832 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.mdx index f519d2278b3..f210ef754fa 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.mdx index 921190e1418..4af64f30b42 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser # BlockCollapser - + Bases: `object` Class to consolidate a given block from the dag into a single node diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.mdx index 7b7bafebb97..425c7f9734d 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector # BlockCollector - + Bases: `object` Class for implementing block collection on a DAG. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.mdx index e605c7cb4f9..502863bf847 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.mdx index 99ef26d93fb..c4995152d79 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.mdx index da4d9b1be7a..86969737551 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -25,7 +25,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.mdx index 7075eb2776e..e37dbba1888 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.mdx index f4363b1816d..e2ae2c8bd14 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.mdx index 849582ac19d..21bb499d2f4 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.mdx index 41b22d7c5eb..f8e90471459 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.mdx index 5859547d934..b907e71c67b 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.mdx index 080ae94ba13..f338aa20a17 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.42/qiskit.extensions.Initialize.mdx index 626cc6e4293..739961fdc28 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.mdx index 8b9b86ec139..6d9916a34be 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.mdx index a3ffe1b4c7e..da3a1d66430 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.mdx index f9f778b716a..03b394314dc 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.mdx index b880c4c74f6..2f8e2800ef6 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.mdx index 8b575b2ab66..4a449078e26 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.mdx index bf82c0a8782..90c488f1c89 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.mdx index 97630076d78..eb5b47d2b4d 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.mdx index 1b526a646f6..9a9a49c3ec5 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -37,7 +37,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -115,7 +115,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -165,7 +165,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -243,7 +243,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -283,7 +283,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -293,7 +293,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Return type** @@ -307,7 +307,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.mdx index 1ca7ded6fea..87c97f5a59d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.mdx index b3603a834c5..979953aa3ff 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -41,7 +41,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.mdx index 11547e894d1..7798994dd8f 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.mdx index 61f2ab5d897..152bfaf86ad 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `abc.ABC` Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.mdx index 5ffe5b3ed21..43a72dd7124 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.mdx index 07f02ec2d36..491936057be 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -157,7 +157,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -214,7 +214,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.mdx index 6e3460d10b6..bbefca6ddf1 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.mdx index e18c9262f3d..704dcf18ffe 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.mdx index f842b965af7..93ec69daec7 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.mdx index c6ed5b2625d..15f76105d7d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.mdx index 74cfcc30b58..27ddaa3874b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index fcd14f20987..9672668447d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.mdx index d68f81dbf3d..c996640f042 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.mdx index 16b8ec132f9..6195ac5e035 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.mdx index 44476a76afe..434d1459cad 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.mdx index cdb3fbe28b7..a64920d7053 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 730e39ed072..13edeea8621 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.mdx index 44ef970b145..76b52e6644a 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.mdx index 1da896ceb91..5b4b9affbc3 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.mdx index 746ab75f727..daaff9afbc4 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.mdx index 155fa9aeaff..d71e2d237c4 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.mdx index dfa3423bac2..6ad85175979 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.mdx index 099557b66a1..670788d5ed9 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.mdx index 5e87b6d2615..0d921851b52 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to gradient operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.mdx index cec4257a7b6..cc01ea178c2 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Circuit to Quantum Fisher Information operator converter. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.mdx index faf96c659f4..4da7b6f9376 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Base class for differentiating opflow objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -66,7 +66,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.mdx index fde8e974a6f..0a95ab5aec0 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.mdx index 97c950783d8..15172ced512 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.mdx index 51b1e6eee7a..fdba0b78054 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.mdx index 4a219e1b469..0047c4df28c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.mdx index fe45879ca36..28c79099ae3 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Convert an operator expression to the first-order gradient. @@ -57,7 +57,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.mdx index e176b7b65fe..6f62a06f814 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.mdx index 25f59ec85e7..9aa08f21880 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.mdx index 70afdcfad46..e81c53981c6 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.mdx index 12edc3e73fc..1345591db8c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -108,7 +108,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.mdx index 92195695d1d..ebb760a249d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.mdx index e26101ada5b..b8e9c4c6a0b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.mdx index 1b80780b51c..0756830fa0c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.mdx index 4e15fa0d31c..b9d62bd9678 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.mdx index ad0736c2af1..67bf0ef7606 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.mdx index a7fdc74dca2..b08721d8742 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 903afc4c435..4bfcec0799f 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index dcf0b10bfc8..138175fd627 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 82acd47d2b2..ee19366191a 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Z2 Symmetries @@ -79,7 +79,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.mdx index f30858525fe..c60ad20d60b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.mdx index 6763cb97247..8511a8a0fa8 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.mdx index 8caa38d8dd9..2944ae4b914 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.mdx index d047bcc2057..8fbe5d18496 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 6f666f7644e..3d3fdbd11c7 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.mdx index fa6f4d9c84f..663877c2891 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.mdx index f2294eb6556..0ad50012cbc 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.mdx index dc5b010f81c..b121b1e1234 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.mdx index 26890742e0a..7f9e04eb458 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.mdx index 63cdde00bb0..7f24b45f0bb 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Estimator base class. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.mdx index 0989924fcaa..b7ff3a6ec1f 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` Sampler base class diff --git a/docs/api/qiskit/0.42/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.42/qiskit.primitives.Estimator.mdx index 6215f29ee13..bafa6ce7608 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.mdx index bbd9b42f9f0..bd77c2a48e0 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.42/qiskit.primitives.Sampler.mdx index cc47e0c14c1..8d68fd03d96 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Sampler class. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.mdx index e79f7762790..c7e83d31dac 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.42/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.42/qiskit.providers.Backend.mdx index 887f1859eea..a722474411d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.mdx index 1c0ee251000..b4c0d7c1121 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.42/qiskit.providers.BackendV1.mdx index f3e0d94bf8c..10ac94acc81 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.BackendV2.mdx index a7f331e06f9..14ec853a6ed 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` Abstract class for Backends @@ -150,7 +150,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.mdx index 89498edcdd4..f568a1fec3a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.42/qiskit.providers.Job.mdx b/docs/api/qiskit/0.42/qiskit.providers.Job.mdx index 64ab49b2f1f..da8f09fb4ea 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.42/qiskit.providers.JobError.mdx index 04707cbe24d..47ba2977096 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.JobError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.42/qiskit.providers.JobStatus.mdx index 0cfaf9b16b3..08137bb31d6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `enum.Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.mdx index f9ee888fed4..4806d5aba83 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.42/qiskit.providers.JobV1.mdx index 6eb369c4710..96a08f05f51 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` Class to handle jobs @@ -83,7 +83,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -99,13 +99,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.42/qiskit.providers.Options.mdx b/docs/api/qiskit/0.42/qiskit.providers.Options.mdx index f5e5399003e..35425d604c7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `object` Base options object diff --git a/docs/api/qiskit/0.42/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.42/qiskit.providers.Provider.mdx index 5253ceb47a4..795171f3d79 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.mdx index ba2cf7bb355..cd2201e3ba8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` Base class for a Backend Provider. @@ -17,7 +17,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.mdx index feff4c88e54..4501280e380 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.mdx index d8845e14628..6b836ac36a8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.mdx index cb4e32934a1..c713cccd06e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.mdx index c231aef7448..697c4dd1b3a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.mdx index 767dba44240..32556f1c6fc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 9f71ccae670..ef1dc3666a0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index d6117097e48..aaf72892372 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index c75640861c9..bb50a8474d8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 3e4148932e5..1185d7e03bb 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.mdx index 9f8bb6fdf7c..a7620da06ad 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.mdx index 9aaac799421..707eca9d8b6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index 63c687d80ca..be123945626 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.mdx index fffee430ac7..413dc1c34ca 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 2c6f1ad1be6..ebd7d9296d0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.mdx index 91a3a1f5935..9be4117ade3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.mdx index 20a26adac14..1ad0fd55d28 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.mdx index 9cd0fb9f07d..f93889056fb 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index 3cac7353c03..5361fe78fc1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.mdx index b92c97fc251..5add323142f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.mdx index 0b578b3e5d7..57887cf63db 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.mdx index bb1c6c95ec2..eee23267e01 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.mdx index d8c5a078f4a..e50ff954b4d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index f3a77d4d519..57d76efdced 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.mdx index feb0307e877..a6d7f9ced96 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 0326b7cfaa4..cfadb5beab8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 5b6d073d20b..737679044b0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index afeb804a56f..984fa26b64d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.mdx index 662d6868d85..d845beeac02 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 028aa7423f7..4a71fc6550a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.mdx index d2646864f39..54cd4acad53 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.mdx index 3cc61b467a9..99a77c4ae26 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.mdx index 41237f4bde5..ad30400150b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index 2844c7b2781..7b0790e2ad3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.mdx index 9f1f4ddbdf0..63d78e8ee2e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index f5b5ce1a1e8..5a1dbd50162 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.mdx index 998b44ea7ed..35b0901ff3e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.mdx index 92fd3dfdda2..fb5dd96fe06 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.mdx index 65f7731e190..4eca354e0b9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 003fe202e9d..50d4701df7d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index 52736e02a9e..c01aa44aaa3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.mdx index cb9ccd58f13..dd22406b6f8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 7553c20ed91..86f54bd55e0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.mdx index 3d292daa1a2..151fd3179fa 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 1271bb54e36..b71c58c05b5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 275ee9eddba..d4430c413ba 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 40620bc981d..7c71ba09e95 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.mdx index 6539bf8545a..0ac4a7edc9c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.mdx index f3f155e45c8..348c58f1345 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.mdx index 3407a477e37..3335d0805b8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.mdx index 872bebb3431..8e0aa38669d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.mdx index 6d1f82c473d..5a03fa1a04d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.mdx index 62d24c9d73f..1cdac9aa927 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.mdx index df21c601ba3..eba394c76d5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.mdx index 90f1b4a8bc2..715e059adc6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.mdx index d106688b810..af49269b156 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.mdx index 9311d88aecd..05ae3d3cd92 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.mdx index c29f68c9c44..20269ab2ef0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.mdx index 12dde2ae5ed..25e03c8c755 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.mdx index f1a41cc718e..a186c520d48 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index 50cc8423f55..16a2f8af201 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.mdx index e41c60a71ff..e697edc6427 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 915eeeb7fb3..f6156ac6058 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.mdx index ddcbc95c712..2906e3acb33 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 17d3c3788f7..6010ccbe445 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 219a79b5e10..070fbf76859 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.mdx index 09f7c3051e4..ce74d6e3568 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 6fa94081348..4b733a71b72 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 7fba5b560a3..5bc008a933f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 28926314ca4..a25e799fd3a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.mdx index 8e4380d66a1..a5ef40bb657 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.mdx index 0147cce97bf..db5e649080b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.mdx index 982973b4a00..fae2b4d5b1c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.mdx index f7a52d282af..f889776b2eb 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.mdx index 112817a89d2..f8861f01f4c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.mdx index 570cb6261aa..fe88bca415d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index f02e6d8f239..96b4886b769 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index 477b90dae73..67bfb162735 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.mdx index f49411bb985..6118766e2da 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.mdx index ebfc93e81c6..ab1a3c003ec 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index a66a9c08abe..d41796fe10a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index c5b88b5d511..fdc620d168d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.mdx index e7acf63d7a9..5600cb044b1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 77ca0994801..f2bff1312df 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.mdx index e276416aa4a..3f8dc4695a7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 6e0f2248c5f..d2246add54c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.mdx index ba28bd56585..424a0e85056 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.mdx index 300832db14a..10166e13b0a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 14669c66d00..70270962d9e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.mdx index eb67cac5985..d7317750161 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index c42c209f613..12e7c66784a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.mdx index f8809936589..faa2ae194f7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.mdx index bc82abbad06..dd665d8b3c2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index bbb8eba4dac..81d85530a61 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.mdx index 705c086ea10..b2a6a41dbb9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.mdx index a6708774a2d..b1ebacdbcb6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.mdx index 57163731369..2fad8d20670 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.mdx index e9faabb6245..e030ea3593b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.mdx index 176e11e63f5..f2d200ac129 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.mdx index d220ecc7f2a..86815a26e11 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.mdx index 64304d6d2d7..64a68f23162 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.mdx index a8bdf0c2d4d..acdf9a76e9c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.mdx index 77350f9f9fe..a744a8f40c3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.mdx index a7d4b963123..bfed5a126a0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.mdx index 24521e5440b..e0780e70ea9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 2a583cffca1..c8886b4133f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.mdx index 37cf3c9bc6e..078c8fc6ae6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.mdx index f072a12c718..b91f2a56127 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.mdx index 64d3cd2b706..e0231631a42 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider # AccountProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.mdx index 8ec124133cc..32022e75e3b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit # BackendJobLimit - + Bases: `object` Job limit for a backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx index d283318850a..8929cac8fbd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat - + Errors raised when the credentials format is invalid. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx index 972fbc7742f..35f9633db94 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken - + Errors raised when an IBM Quantum Experience token is invalid. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx index 12e07e8e2e1..909503199c1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl # qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl - + Errors raised when an IBM Quantum Experience URL is invalid. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx index 678b6f00d34..12ffb9c86b5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound # qiskit.providers.ibmq.IBMQAccountCredentialsNotFound - + Errors raised when credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.mdx index 355dda7c778..fae48ed5f9e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError # qiskit.providers.ibmq.IBMQAccountError - + Base class for errors raised by account management. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx index 8201d028ab1..f80093863fd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound # qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound - + Errors raised when multiple credentials are found. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.mdx index f1a92da626c..457f6df32fc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend # IBMQBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.mdx index 9dec97ce7c6..76cf079caec 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError # qiskit.providers.ibmq.IBMQBackendApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx index 64db4647870..d25cf2cec91 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError # qiskit.providers.ibmq.IBMQBackendApiProtocolError - + Errors raised when an unexpected value is received from the server. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.mdx index a8b3c7fcc99..4727f72b433 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError # qiskit.providers.ibmq.IBMQBackendError - + Base class for errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.mdx index 3b860da157b..dd5f672858e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService # IBMQBackendService - + Bases: `object` Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.mdx index a351d4a7de6..3d440dbd168 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError # qiskit.providers.ibmq.IBMQBackendValueError - + Value errors raised by the backend modules. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.mdx index 25725289525..a799a22575d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError # qiskit.providers.ibmq.IBMQError - + Base class for errors raised by the provider modules. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.mdx index df680555a43..44853a77532 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory # IBMQFactory - + Bases: `object` Factory and account manager for IBM Quantum Experience. @@ -45,7 +45,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### delete\_account - + Delete the saved account from disk. **Raises** @@ -208,7 +208,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### save\_account - + Save the account to disk for future use. @@ -251,7 +251,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### stored\_account - + List the account stored on disk. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory ### update\_account - + Interactive helper for migrating stored credentials to IBM Quantum Experience v2. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.mdx index 82899e264c1..80738d94f55 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError # qiskit.providers.ibmq.IBMQProviderError - + Errors related to provider handling. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.mdx index 556a1662fc6..7e71921a93b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult # RunnerResult - + 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") Result class for Qiskit Runtime program circuit-runner. @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### decode - + Decoding for results from Qiskit runtime jobs. **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.mdx index fc2441800e5..12e05665abd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials # Credentials - + Bases: `object` IBM Quantum Experience account credentials and preferences. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.mdx index 140ea22b29f..898906a852c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError # qiskit.providers.ibmq.credentials.CredentialsError - + Base class for errors raised during credential management. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx index 5e3aedfb95c..1a7f4ba11cc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError # qiskit.providers.ibmq.credentials.CredentialsNotFoundError - + Errors raised when the credentials are not found. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx index dcd14e43748..603cb4925ec 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError # qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError - + Errors raised when the credentials are in an invalid format. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.mdx index a0621ae2a94..c1bc978f338 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent # DeviceComponent - + Bases: `abc.ABC` Class representing a device component. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx index 6c5a71cae4d..df0b2502e74 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists # qiskit.providers.ibmq.experiment.IBMExperimentEntryExists - + Errors raised when an experiment entry already exists. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx index c83428a2780..9174dc99629 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound # qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound - + Errors raised when an experiment entry cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx index 2161c2ac7ae..a57a3f0beb7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError # qiskit.providers.ibmq.experiment.IBMExperimentError - + Base class for errors raised by the experiment service modules. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx index ca71a7db4c1..f40a42896a9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService # IBMExperimentService - + Bases: `object` Provides experiment related services. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.mdx index a9565716139..894d26703a4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality # ResultQuality - + Bases: `enum.Enum` Possible values for analysis result quality. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.mdx index f2d2d7dc516..7d16080d5f4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob # IBMQJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.mdx index 9eb71ce8498..a3fd47696e8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError # qiskit.providers.ibmq.job.IBMQJobApiError - + Errors that occur unexpectedly when querying the server. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.mdx index 3896d64d987..58ed8123c32 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError # qiskit.providers.ibmq.job.IBMQJobError - + Base class for errors raised by the job modules. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx index 9129540958e..4450de7b763 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError # qiskit.providers.ibmq.job.IBMQJobFailureError - + Errors raised when a job failed. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx index 205b3c946dd..de88fb0db2e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError # qiskit.providers.ibmq.job.IBMQJobInvalidStateError - + Errors raised when a job is not in a valid state for the operation. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx index 5a018b1ed6a..fe440db4c0c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError # qiskit.providers.ibmq.job.IBMQJobTimeoutError - + Errors raised when a job operation times out. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.mdx index 2b95d5b8901..fb6ce7e6a0d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo # QueueInfo - + Bases: `object` Queue information for a job. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.mdx index e3feea1c9ed..2f4afaf6880 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager # IBMQJobManager - + Bases: `object` Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx index 6141fc50d55..fc00914c5bf 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError # qiskit.providers.ibmq.managed.IBMQJobManagerError - + Base class for errors raise by the Job Manager. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx index 21593014028..bf727b05988 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError # qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError - + Errors raised when an operation is invoked in an invalid state. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx index 34adc37569e..25ce03d8040 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound # qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound - + Errors raised when a job cannot be found. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx index fdbec51a7d5..bf67962a9b6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError # qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError - + Errors raised when a Job Manager operation times out. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx index 1130cc1ac5a..280d5b99fe0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet # qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet - + Errors raised when the job set ID is unknown. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx index 0c184157ab5..5f1232151ce 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable # qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable - + Errors raised when result data is not available. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.mdx index 4a3398fd80a..f326a03ffee 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob # ManagedJob - + Bases: `object` Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.mdx index d570e790fed..e74ba210f9c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet # ManagedJobSet - + Bases: `object` A set of managed jobs. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.mdx index 2332f1b70d3..bdc5980ab2f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults # ManagedResults - + Bases: `object` Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx index 04ffd895e83..744269571a6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService # IBMRuntimeService - + Bases: `object` Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx index 2b4f9f5ceba..d3d729835aa 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace # ParameterNamespace - + Bases: `types.SimpleNamespace` A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.mdx index c81dcab7b6e..4353eabfebf 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend # ProgramBackend - + Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` Base class for a program backend. @@ -35,7 +35,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -131,7 +131,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend ### run - + Run on the backend. Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.mdx index 2c33cc5299f..1e4d7ea621a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder # ResultDecoder - + Bases: `object` Runtime job result decoder. @@ -38,7 +38,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder ### decode - + Decode the result data. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx index e86956257b6..831b12153f1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `json.decoder.JSONDecoder` JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx index c8fc29189db..448d6998b89 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `json.encoder.JSONEncoder` JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.mdx index d6cdbcae855..4629983891b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob # RuntimeJob - + Bases: `object` Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx index 0f8e57ab2b2..0b257d25da3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions # RuntimeOptions - + Bases: `object` Class for representing runtime execution options. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx index 191af7e544d..72fd7d58e27 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram # RuntimeProgram - + Bases: `object` Class representing program metadata. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.mdx b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.mdx index d669f56de4d..2c4301151e0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger # UserMessenger - + Bases: `object` Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.mdx index 5d433caad00..c21da4a2ffa 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.mdx index c9fda81e9a4..80a4315aa25 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.mdx index 7bb78b0a4e4..646ea3a3d07 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.Command.mdx index 65a4ea1db89..a381c5bd743 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.mdx index fd1bafd2ddc..64fae73c04b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.mdx index 570a87099d3..d1d7bd5223c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.mdx index 5d1bf50f811..d00725777b2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -156,7 +156,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.mdx index 948ebe38e0e..4be8c157b3d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.mdx index 19eea837992..f08a9685936 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -155,7 +155,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.mdx index 41101afc93a..d711cd26c41 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.mdx index 0303bd8125f..a1979b456b4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.42/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.42/qiskit.pulse.Schedule.mdx index dd54ca2c1b8..137d3f63fbf 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -258,7 +258,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.mdx index ffc2099785c..95f67fe763a 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` Time-ordered sequence of instructions with alignment context. @@ -422,7 +422,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.mdx index 4f6d7d4c719..bc861fdb905 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.mdx index a78b5a833d9..6b522537751 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.mdx index 840339c240c..caadfac9ae9 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.mdx index 3c43da3ee95..52872b7349d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `qiskit.pulse.channels.PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.mdx index 4d26850a2c7..4a65499add4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.mdx index ecbc856ac01..e566453acc0 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.mdx index 8332d67699a..738a9994ed1 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `qiskit.pulse.channels.ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.mdx index 1317b7b6258..87ed9849d31 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.mdx index 7eb3157cdb3..ee70120393d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.mdx index 2ea378c66f3..4b1d7c26ef5 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.mdx index d7a924c14be..f407b06dbe4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.mdx index b34ac806d1b..4ca527d4343 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.mdx index 4268b6a9d23..789ea2c0663 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.mdx index d668e6c1bb5..1413f530f2a 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.mdx index dd823d5974d..d80b914f9a9 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.mdx index 16b8fad4a74..f749ae9cc07 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.mdx index 5ae68cdd0c2..209270d3543 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.mdx index 92695d32e71..361269b515e 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.mdx index 3fc2bbd5a05..c8bb9586554 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `qiskit.pulse.instructions.directives.Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.mdx index 6163dc7eda2..cf638b3550c 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `object` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.mdx index fa2663be2e2..e02dcf56fd6 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `object` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.mdx index 6045ee6973a..ba419a51dbf 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `object` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.mdx index 55e3f8c321e..13e9e688e63 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `object` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.mdx index 3b2e98df065..c35ebad5abe 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The abstract superclass for parametric pulses. @@ -65,7 +65,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.mdx index 6cd51698489..eb71994c479 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse # ScalableSymbolicPulse - + Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") Subclass of [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse") for pulses with scalable envelope. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.mdx index 28bbb4a84ab..f8c229068ae 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `qiskit.pulse.library.pulse.Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.mdx index d6fd9207a8d..8f22c7252d9 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `qiskit.pulse.library.pulse.Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.mdx index 699dab9077c..af0a0c3e1b6 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.mdx index b60836b72bf..58862c18439 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.mdx index 3af254d7186..49590b6b3f6 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.mdx index a52eef945db..3eba1d49adc 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.mdx index 46b0d55099d..96a8a1df936 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.mdx index e9f2be669f8..c7729c6cbe5 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer # OpenQASMLexer - + Bases: `pygments.lexer.RegexLexer` A pygments lexer for OpenQasm. @@ -23,7 +23,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### analyse\_text - + Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.42/qiskit.qasm.Qasm.mdx index 3bfa2b53908..e816cc0d70e 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.42/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.42/qiskit.qasm.QasmError.mdx index c8873e06066..93833363baf 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.mdx index 05dce2c03ac..16b5ea61e38 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle # QasmHTMLStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.mdx index 7e00f4c2407..8504807c2ba 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle # QasmTerminalStyle - + Bases: `pygments.style.Style` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.mdx index 5b7e9a61f6c..d74f9f7ac6e 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.mdx index 4c3c320848d..19cb26de112 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.mdx index 8cfcfc082c5..2161c764599 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.mdx index 3998a8d6554..8e5c04b0613 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `qiskit.qobj.common.QobjDictField` A configuration for a Pulse Qobj. @@ -35,7 +35,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.mdx index a9db8f63a66..5265726f3c4 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.mdx index 2b756385b12..fb6c7ca4e46 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.mdx index 9dd6329a0ce..45439cbd3e5 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.mdx index a95788c6ed8..4bd63562087 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.mdx index 071a2701bfa..2ad387eadf8 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.mdx index 01ef04221d6..d6e04ed3dbb 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `types.SimpleNamespace` A configuration for a QASM Qobj. @@ -37,7 +37,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.mdx index 5511bde7f4b..c5ca81a51c1 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.mdx index 8c04d759ac6..0b325fff1be 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `qiskit.qobj.common.QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.mdx index f84c4c7897d..f0cfb72ecc3 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.42/qiskit.qobj.Qobj.mdx index 55e79ab2d96..741f8a34430 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -19,7 +19,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.mdx index 919aa33c873..7a10fd7c458 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.mdx index 0080959e8f6..5d746d8c0d1 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `qiskit.qobj.common.QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.mdx index 67c78e5acf2..8eda984804a 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.mdx index 1562284cc6b..9a6af1ed2c7 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.mdx index d77c2417850..b7527c6bbdf 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.mdx index 2d2eb8acb37..d1ece396842 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.mdx index bf91e0c7923..c6d287f7409 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + 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") An N-qubit unitary operator from the Clifford group. @@ -161,7 +161,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -183,13 +183,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.mdx index c8c2ed8400b..11043b65cba 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` DensityMatrix class @@ -150,7 +150,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -174,7 +174,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -200,7 +200,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.mdx index 36d9bfb36b0..73840d9c9b5 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 57b38f236a2..5a8088b7ffb 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.mdx index c41c26cfd8a..82d1ba81b58 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class @@ -156,7 +156,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -181,7 +181,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.mdx index 2d5851a795f..42c1ed023fd 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.mdx index f1d00e7882a..a70d1e15bbc 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` N-qubit Pauli operator. @@ -393,7 +393,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.mdx index 4f9ed7927a0..6a5c3e587e0 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` List of N-qubit Pauli operators. @@ -366,7 +366,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.mdx index 17baa7b1c1e..8e00bef3e0d 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` Symplectic representation of a list Pauli matrices. @@ -328,7 +328,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.mdx index aa082bf87f5..00d28a88640 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.mdx index 2eac1eb97fd..57228f22ae5 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.mdx index b435a7683b3..d67c69b9753 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -269,7 +269,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -305,7 +305,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -331,7 +331,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -612,7 +612,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.mdx index ef576b0c0fe..e556be6cf9b 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.mdx index c5c19047a7e..5420750b1e8 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + 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` Symplectic representation of a list Stabilizer matrices. @@ -361,7 +361,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.mdx index c5b6953bd3a..b73b96359b5 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Statevector class @@ -191,7 +191,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -215,7 +215,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.mdx index 26f1c11678e..fd6dac8a387 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.mdx index d5fc59f33e6..ad7ff0f3ef1 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 0290cf2e18c..c080d00f368 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.mdx index fe9ab6a3552..f6882ee1f2e 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.mdx index d2d70407b76..c5ac7d03f69 100644 --- a/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `abc.ABC` Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.mdx index d74bca8f076..ab06ba79062 100644 --- a/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.42/qiskit.result.Counts.mdx b/docs/api/qiskit/0.42/qiskit.result.Counts.mdx index f7a11750401..85aa945e454 100644 --- a/docs/api/qiskit/0.42/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.mdx index 2638218f164..a287ac90e77 100644 --- a/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.mdx index f8587dc2022..adbd050728c 100644 --- a/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.mdx index f551d88f8b5..b733a988051 100644 --- a/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.42/qiskit.result.Result.mdx b/docs/api/qiskit/0.42/qiskit.result.Result.mdx index 8cd4bd877a5..7d42e5a0137 100644 --- a/docs/api/qiskit/0.42/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.42/qiskit.result.ResultError.mdx index 0f55fbc6dc5..bfe69c22116 100644 --- a/docs/api/qiskit/0.42/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.42/qiskit.result.ResultError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.mdx index 119b2bd18e7..819946bc691 100644 --- a/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.mdx index a80fbe0d1dd..bdcc28f39ed 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `abc.ABC` Interface for evolution synthesis algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.mdx index 98daf53fdcd..f26b7876933 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.mdx index 0d4eea5fd12..bdeba1f8653 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.mdx index b594f084085..0148a3733ef 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.mdx index 39ce5453758..9e7e14d78d0 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.mdx index c6fc0c5e9b3..b069c90f0fb 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: `object` The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.mdx index 706e27d2336..0eb5c1d4d2e 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.mdx b/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.mdx index 3b3fa54541c..8f6081944cf 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.mdx +++ b/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.tools.events.TextProgressBar # TextProgressBar - + Bases: `qiskit.tools.events.progressbar.BaseProgressBar` A simple text-based progress bar. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.mdx index 295a631c7e3..c25a853a7b0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `qiskit.transpiler.basepasses.BasePass` An analysis pass: change property set, not DAG. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.mdx index d9b8db1d080..bfcd4875876 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.mdx index f4fafed070a..4c5daa88516 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -93,7 +93,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -189,7 +189,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.mdx index 7c6eaaa2c77..7fe570a3365 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -28,7 +28,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.mdx index de1cf4ae53a..4d71f3c4e45 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.mdx index 87a7baca575..be1ee7ccad9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `qiskit.transpiler.fencedobjs.FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.mdx index 0c0c6845a02..400a1a199b9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -30,7 +30,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.mdx index e60070c007f..95853a37c17 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.mdx index 33049c65c94..d40c042d370 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.Layout.mdx index 68a9f321f05..fa691ccfd2b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.mdx index b953f4dc664..0421780217e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.mdx index c94346776a4..6f3feaed451 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.mdx index 4c017f30d6b..b488ff3dd1d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.mdx index 35739d214ca..ebf2caac722 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.Target.mdx index 10fd5e19eed..bcd7d2422b8 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `collections.abc.Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.mdx index 7b874541f8b..404c67f794d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `qiskit.transpiler.basepasses.BasePass` A transformation pass: change DAG, not property set. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.mdx index e50155d6d53..289487edf1e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.mdx index 233e82112d0..d275823660b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx index 1597a6f9dd9..5774cca2726 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation # ACGSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.mdx index bc709e8cc66..e7cfd7d5246 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index cde990b13e7..0b3da63f960 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.mdx index 906fec4bf10..5ffc984c924 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 0be306576d5..de1ee66d540 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.mdx index 4809dd56583..cf83adbd9d2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.mdx index 57ed49629ba..a017b5a3baa 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.mdx index 594fa0babff..f388f968c0d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 0ba6e2c79e8..8f301cbc76b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.mdx index 5ee3f4a567e..3c8eb8b03f4 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx index 5db3ac502f5..7c28bae90b9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation # BasicSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on sorting. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.mdx index 7dc4127f258..f1c25993fd9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.mdx index fbd71707caf..1b5d61ee526 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.mdx index 6187966727a..b7188f59afb 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.mdx index f7d5ff0cad2..913e62f0dd3 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.mdx index 9579802bfb9..f9ff2fa3cdd 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.mdx index c8c11c626a5..2fd03a955af 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.mdx index 16240158f20..9281a2a1ae0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.mdx index 4dea17057da..076f57e3b7d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.mdx index 4f71419a922..ded7ce800d7 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.mdx index 231c0c150bd..aa7cff5c360 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse # CollectAndCollapse - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A general transpiler pass to collect and to consolidate blocks of nodes in a circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.mdx index 0ef475ae766..3b03c862f69 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 94ca530af82..9bcf81db622 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index fa7b1410cb9..4dfadb3178b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.mdx index 3c8a2747d4a..e2817a37433 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.mdx index 55fc184cb7b..1fa6fa0906d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index d49dc963659..aa70816931c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index d1112cee107..8a423f2d52d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.mdx index cb9bdc5c269..796d8a473a0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.mdx index d1c4f9cf4d6..5b81043d765 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.mdx index 3aa30179981..09d7410423d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index 22a08f88511..26339c37b94 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.mdx index 0b0c96d80d4..b4baa215462 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 1127044f7fb..5100f430c1b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index f4d3c084d45..ba208ba832e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.mdx index 5e40ee4a25a..d5bbf8a8580 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.mdx index 902690eb354..5d460defe28 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.mdx index 32b1363b096..f26ebf56a95 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.mdx index 12d14cb6153..ecf8d895d69 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.mdx index 450217a6960..6da6a3723ab 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.mdx index d84d1af7f98..191403d3f80 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index c3947931765..1e88eaa13a0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 28831351b0f..5a41e9fd749 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.mdx index bfcd5062daa..d9da55beacd 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.mdx index af229585b87..4cb66d992c1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.mdx index 3ddf9b6ee2d..6045c78cf5d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.mdx index 84d87c44090..666b5bf21fb 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.mdx index d006d8246a8..0dfa82d586d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects by choosing the appropriate synthesis method based on the object’s name and the high-level-synthesis config of type `HLSConfig` (if provided). diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.mdx index 0e739707668..0bb19292c57 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 9480119c285..a835c0ec273 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.mdx index 741e921953b..2d4d5ad9fb0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx index e3f207a075a..342a7bbf670 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation # KMSSynthesisPermutation - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.mdx index a62fe11e77f..c030197a8cf 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 7a7e5818fb2..14a2c4b737c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index b7c9234b174..f1cd0eab785 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.mdx index c3e27c863dc..e9c0cc4059a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 3182cd3777d..d52f18cd0a1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index c7e5b614b6d..8b62a9f6e60 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.mdx index 1e841e85a91..c54c3061276 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.mdx index e2bd342f9ec..5665d883f5a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 62f8ab0194b..f98e0f3f990 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index b1dd28ac13e..7dea352de1f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.mdx index 5478fc11ba9..d5d406991ef 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.mdx index 7592bfa780a..662392749a4 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index ad6a8724602..3883556b7e6 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.mdx index 8b60d53d0d1..d713d5b59b2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index fc85672d1d2..9d568aa5387 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index d75cd8c4a11..29f2b746f7e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.mdx index 6def9de450c..953312e00a1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index e8a7acab4d9..ab75f601ad4 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index d4c5c3a31ac..1dbd59ac1ee 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 98e77a93fd9..bb8819a0b0b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index bfbe5f210fd..6372c24337b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.mdx index ea2eb2f8599..32905b1fa94 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.mdx index 5fb5a722ddb..a810c55ade2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.mdx index 3988177a07d..222968918ce 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.mdx index cb0d7a736c7..4be4c915a5e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.mdx index 3a8e2d07b2c..1738eff74d2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.mdx index f854432eb9b..667c1b283f8 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index 8c0e3481fb0..ea94cf57e50 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.mdx index 57a91748a57..524dbb507ba 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.mdx index 354c1e8beb4..a5b7a41bd91 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.mdx index 6c7d4a74da3..0e7025499e5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 6488016c10d..250d5010291 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.mdx index a922a0c6a1b..1f02df35170 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.mdx index d4d334d9bc0..61fe06da331 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 2ba00ef143d..b7a4e90b523 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 90dc272f476..32b3af62390 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.mdx index 7b5ff13427a..a4eb84695aa 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.mdx index 2f0aa847253..c7398b0c8c2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.mdx index a0d38b3d6b2..489cf843383 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.mdx index a30fe7a491f..40e3153cc9c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.mdx index 1cbb4d742df..2824602612f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index fc04d692403..8802aeeab3f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: `abc.ABC` Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 362a790d3e1..5cb13d69755 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: `object` Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 875395beb27..d810acb27d7 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `abc.ABC` Abstract unitary synthesis plugin class @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 53cc8283379..119faa702bd 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 2e500eb86ce..3c7b4bef63a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: `abc.ABC` A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 2d0155cc7ab..360846da1d9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: `object` Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.mdx index 91e1508c3b0..6e2016852ae 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index e0e8281992c..4535a7f247c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 90885734516..2bb2d1e6920 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` A base class that represents an approximate circuit. @@ -22,7 +22,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index a74edbfc470..6ff295914ab 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `abc.ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index 4a95495b914..6e82781d5a7 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 5dc1b341636..ea797281119 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index e8ac95e07f2..082dfe8f221 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index a2498d18465..c9e6d378d5c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.mdx index 36918667cfd..ffabd6a6b2b 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 83076757d9d..eec601dcc6d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.mdx index e39835bb1f5..b468b72b51d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.mdx index 4d55d258b3f..329da8e7312 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.mdx index 454f978b1a9..00f178bdac8 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.mdx index afe1fc6c6e5..7ad18446ec1 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.mdx index 389188a0250..b42ea8c80ee 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.mdx index 631ef20b2ce..c9deaaa23e2 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerError.mdx b/docs/api/qiskit/0.42/qiskit_aer.AerError.mdx index b74699b97ed..f26eb53f2bb 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerError.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.AerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerError # qiskit\_aer.AerError - + Base class for errors raised by simulators. Set the error message. diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerProvider.mdx b/docs/api/qiskit/0.42/qiskit_aer.AerProvider.mdx index 22920107e33..449a7a11f36 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerProvider.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.AerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerProvider # AerProvider - + Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.mdx b/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.mdx index 60c8871fa88..552d879fda8 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.AerSimulator # AerSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -255,7 +255,7 @@ python_api_name: qiskit_aer.AerSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.mdx b/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.mdx index 7a6332fcba5..f5ed3939378 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.PulseSimulator # PulseSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Deprecated: Pulse schedule simulator backend. @@ -142,7 +142,7 @@ python_api_name: qiskit_aer.PulseSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.mdx b/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.mdx index 46ececa3309..522fdb3797d 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.QasmSimulator # QasmSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Noisy quantum circuit simulator backend. @@ -183,7 +183,7 @@ python_api_name: qiskit_aer.QasmSimulator ### from\_backend - + Initialize simulator from backend. diff --git a/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.mdx b/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.mdx index aa679e8f5a9..efe18552561 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.StatevectorSimulator # StatevectorSimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.mdx b/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.mdx index aff134cef00..e841e45871a 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.UnitarySimulator # UnitarySimulator - + Bases: `qiskit_aer.backends.aerbackend.AerBackend` Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.mdx b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.mdx index 8471151507b..d77662cedb4 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJob # AerJob - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") AerJob class for Qiskit Aer Simulators. diff --git a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.mdx b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.mdx index 46277763106..a7d92920aeb 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet # AerJobSet - + Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") A set of [`AerJob`](qiskit_aer.jobs.AerJob "qiskit_aer.jobs.AerJob") classes for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.mdx index 85d07d77b88..c21fa9af48f 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes # SaveAmplitudes - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.mdx index 698e825e014..4d404040331 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared # SaveAmplitudesSquared - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.mdx index d68cc1c357c..e0e78433830 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveClifford # SaveClifford - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Clifford instruction diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.mdx index 2998a4d583c..8961e0d8781 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix # SaveDensityMatrix - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save a reduced density matrix. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.mdx index 9b0baeb3db7..51d5810f487 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue # SaveExpectationValue - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value of an operator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.mdx index e683ebd248e..93f17b5e1c6 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance # SaveExpectationValueVariance - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.mdx index 097df7740e7..869c3cc6831 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState # SaveMatrixProductState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save matrix product state instruction diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.mdx index 99ac590245b..f3b495d6795 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities # SaveProbabilities - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.mdx index 91b86fcf104..3d6f85766bf 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict # SaveProbabilitiesDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.mdx index a8e9e70f53f..d13d2ba1699 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer # SaveStabilizer - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Stabilizer instruction diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.mdx index 15f2f6403c0..e461069d88e 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveState # SaveState - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save simulator state diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.mdx index 40c1f62725a..fd3af13d8ab 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevector # SaveStatevector - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.mdx index 073f81f69ac..513f4658c76 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict # SaveStatevectorDict - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.mdx index 8e644cd4b05..207ac4d0467 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp # SaveSuperOp - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.mdx index 50486ff25f0..42f8535642e 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SaveUnitary # SaveUnitary - + Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` Save Unitary diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.mdx index 25d0c9d16d5..fe66ff8ec1d 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix # SetDensityMatrix - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.mdx index 722859fd1d0..5191391b9ac 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState # SetMatrixProductState - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.mdx index 38a585d748b..6ff26962d9f 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStabilizer # SetStabilizer - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.mdx index e8ad6848559..512a769f3a9 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetStatevector # SetStatevector - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.mdx index 1d851d664ab..775ebce70e2 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetSuperOp # SetSuperOp - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set superop state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.mdx b/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.mdx index b2adb1693d8..865dd418b26 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.library.SetUnitary # SetUnitary - + Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.mdx b/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.mdx index 02be437a5d6..84367b343c8 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass # LocalNoisePass - + Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transpiler pass to insert noise into a circuit. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.mdx b/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.mdx index 70e20648026..64f3290fd8f 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.NoiseModel # NoiseModel - + Bases: `object` Noise model class for Qiskit Aer simulators. @@ -155,7 +155,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend - + Return a noise model derived from a devices backend properties. This function generates a noise model based on: @@ -218,7 +218,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_backend\_properties - + Return a noise model derived from a backend properties. This method basically generates a noise model in the same way as [`from_backend()`](qiskit_aer.noise.NoiseModel#from_backend "qiskit_aer.noise.NoiseModel.from_backend"). One small difference is that the `dt` option is required to be set manually if you want to add thermal relaxation noises to delay instructions with durations in `dt` time unit. Because it is not supplied by a `BackendProperties` object unlike a `Backend` object. Note that the resulting noise model is the same as described in [`from_backend()`](qiskit_aer.noise.NoiseModel#from_backend "qiskit_aer.noise.NoiseModel.from_backend") so please refer to it for the details. @@ -249,7 +249,7 @@ python_api_name: qiskit_aer.noise.NoiseModel ### from\_dict - + Load NoiseModel from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.mdx b/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.mdx index e23f78ef74f..5d2b7cd5293 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.QuantumError # QuantumError - + Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.mdx b/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.mdx index 29cc7e50426..061a0f174c4 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.ReadoutError # ReadoutError - + Bases: `object` Readout error class for Qiskit Aer noise model. @@ -157,13 +157,13 @@ python_api_name: qiskit_aer.noise.ReadoutError ### set\_atol - + Set the class default absolute tolerance parameter for float comparisons. ### set\_rtol - + Set the class default relative tolerance parameter for float comparisons. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.mdx b/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.mdx index 59a77cccd3b..76c599eb83d 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass # RelaxationNoisePass - + Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") Add duration dependent thermal relaxation noise after instructions. diff --git a/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.mdx b/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.mdx index d266a42be9c..dc5f870ca14 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Estimator # Estimator - + Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") Aer implmentation of Estimator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.mdx b/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.mdx index ff6f6b0ca7b..d0852862d1b 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.primitives.Sampler # Sampler - + Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") Aer implementation of Sampler class. diff --git a/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.mdx b/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.mdx index bc153e825fa..b144ec5e0d7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel # PulseSystemModel - + Bases: `object` Physical model object for pulse simulator. @@ -85,7 +85,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_backend - + Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel ### from\_config - + Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.mdx b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.mdx index 091361c4f4b..f226c08ce39 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerDensityMatrix # AerDensityMatrix - + Bases: [`qiskit.quantum_info.states.densitymatrix.DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.states.densitymatrix.DensityMatrix") AerDensityMatrix class This class inherits `DensityMatrix`. @@ -142,7 +142,7 @@ python_api_name: qiskit_aer.quantum_info.AerDensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -166,7 +166,7 @@ python_api_name: qiskit_aer.quantum_info.AerDensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit_aer.quantum_info.AerDensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.mdx b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.mdx index d7a0be79867..93a4daf223a 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.mdx +++ b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector # AerStatevector - + Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") AerStatevector class @@ -189,7 +189,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -213,7 +213,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -239,7 +239,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.42/utils.mdx b/docs/api/qiskit/0.42/utils.mdx index f21ff8c8ce0..ac6439fa39b 100644 --- a/docs/api/qiskit/0.42/utils.mdx +++ b/docs/api/qiskit/0.42/utils.mdx @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -151,7 +151,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -218,7 +218,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -232,7 +232,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.43/pulse.mdx b/docs/api/qiskit/0.43/pulse.mdx index a336aecdafd..5db1e0c9095 100644 --- a/docs/api/qiskit/0.43/pulse.mdx +++ b/docs/api/qiskit/0.43/pulse.mdx @@ -73,7 +73,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -182,7 +182,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -237,7 +237,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -686,7 +686,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. diff --git a/docs/api/qiskit/0.43/qasm.mdx b/docs/api/qiskit/0.43/qasm.mdx index 19c7123ff4f..4fe0ad9d58f 100644 --- a/docs/api/qiskit/0.43/qasm.mdx +++ b/docs/api/qiskit/0.43/qasm.mdx @@ -29,19 +29,19 @@ python_api_name: qiskit.qasm ### OpenQASMLexer - + A pygments lexer for OpenQasm. ### QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.43/qasm2.mdx b/docs/api/qiskit/0.43/qasm2.mdx index 7dbfeebb906..f37ae49a6b1 100644 --- a/docs/api/qiskit/0.43/qasm2.mdx +++ b/docs/api/qiskit/0.43/qasm2.mdx @@ -83,7 +83,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -99,7 +99,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -117,7 +117,7 @@ This module defines a generic error type that derives from `QiskitError` that ca ### QASM2Error - + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -127,7 +127,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError - + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. diff --git a/docs/api/qiskit/0.43/qasm3.mdx b/docs/api/qiskit/0.43/qasm3.mdx index b8cda3fae80..b0457a6ed71 100644 --- a/docs/api/qiskit/0.43/qasm3.mdx +++ b/docs/api/qiskit/0.43/qasm3.mdx @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -88,7 +88,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -100,7 +100,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -203,7 +203,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.mdx index ed1287bcde8..edc2c756145 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError # qiskit.algorithms.AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.mdx index 9492f894724..aa1ef03c08e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.mdx index 4a23129b082..297e07f2822 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: `object` The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.mdx index ccd25d80922..9ecde404b70 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: `ABC` The interface for amplification algorithms. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.mdx index 964f299a169..038b000e066 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -59,7 +59,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -86,7 +86,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.mdx index e67a494ad56..b5b6683a65d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.mdx index 08225a096d5..0356e07b426 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: `ABC` The Amplitude Estimation interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.mdx index da4c0d243e0..fa019e37c17 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.mdx index a8a29235806..7d7b7ba2c3b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: `ABC` Deprecated: Eigensolver Interface. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.mdx index dae524934a3..b16534ee6ca 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Deprecated: Eigensolver Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.mdx index 1c1f9f71e0f..25642d82ed1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: `object` The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.mdx index a0a8354dbf9..aa126fde037 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: `object` Deprecated: Evolution problem class. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.mdx index 799102d4be6..664f4d0e658 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `AlgorithmResult` Deprecated: Class for holding evolution result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 044dabe6b4e..b8964f67e07 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index c5fbb1644dd..15350fa57d4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.Grover.mdx index 0c3b0155bd3..5c69db01bba 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -148,7 +148,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.mdx index d5f1ab97a2c..02d86fa4b93 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index c8c57da7486..35fe4f4ed6c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: `object` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index e235d5b74f0..6d94d6e1dac 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.mdx index c29cf4905c2..1945d866827 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: `ABC` Deprecated: Interface for Quantum Imaginary Time Evolution. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.mdx index 6a6782dec9d..c07384fa6f5 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: `ABC` Interface for Quantum Imaginary Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 60557a3b8bd..b384641c1eb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index c959cc98bd3..1470e1dc609 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.mdx index bf83bb0a50a..be4d2a2b3ea 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 9b2f40b5979..bb824a623a4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index c15ee7c26d2..6c30e4db8fc 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.mdx index 6b3443313ee..7f08f3ed2ab 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: `ABC` Deprecated: Minimum Eigensolver Interface. @@ -27,7 +27,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.mdx index 7df5288621f..32d68617341 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Deprecated: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.mdx index eda6234a7d7..274c89d3d83 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: NumPy Eigensolver algorithm. @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.mdx index e76377ed8cc..ffaa5783724 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Numpy Minimum Eigensolver algorithm. @@ -50,7 +50,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.mdx index ca526de7bc3..939fd5c93bc 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.mdx index c2b20fa27e1..44b94861729 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.mdx index 221dddb7a01..49fd591719d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.mdx index ca22737cfbf..88a3b1649af 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.mdx index 9f5e31196cf..2f9ae5190a8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: `object` Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.mdx index 43347e695fd..987d108b6a1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Deprecated: Quantum Approximate Optimization Algorithm. @@ -159,7 +159,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.mdx index 70708e9f898..046a02e3f30 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: `ABC` Deprecated: Interface for Quantum Real Time Evolution. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.mdx index b68da9c5931..1ab04b67246 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: `ABC` Interface for Quantum Real Time Evolution. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.mdx index 3312dfb23a0..1ae43e958ea 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.mdx index 89c97b4c831..b5b19992f3a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.mdx index 9a93bdbaa64..04ebe2cb635 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: `object` Time evolution problem class. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.mdx index cf69a6fa889..a0f6ad543e3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.mdx index a29d3e6ec6f..b7df5c4aac3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Deprecated: Quantum Real Time Evolution using Trotterization. @@ -81,7 +81,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.VQD.mdx index f3dc19c0408..f03f43c3dec 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: Variational Quantum Deflation algorithm. @@ -164,7 +164,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.mdx index 837e4985628..e30a6017b4a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Deprecated: VQD Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.VQE.mdx index ebc8740a94a..665c2e9ef88 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Variational Quantum Eigensolver algorithm. @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.mdx index 2bbf5732217..5508af1c8a8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.mdx index c98310eb832..6635e604839 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 18a8606ef63..0a4d352e7c0 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: `ABC` The eigensolver interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index b4bdb12a921..097a2e41cb4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index 7caf7550a39..0beba73aa43 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index e2fafce316c..f7ade5b5e92 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.mdx index d8a854c65ab..0f50f244413 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -134,7 +134,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.mdx index c15be4f9cb8..40d40b653c1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index b7f8da3e66d..f5470999937 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: `ABC` Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.mdx index e504d79995a..9cbcae5e1e7 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: `ABC` Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index bc9ef961be3..36840fbd3b8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: `ABC` Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.mdx index 82b5d7b08e1..a413b480faa 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType # DerivativeType - + Bases: `Enum` Types of derivative. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index 41c32f1dac5..af4e9e1cc63 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: `object` Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 785773dd21e..25770687773 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index bb3eac823d8..f8f0e425ed6 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index 347559533e2..e7619c15aa6 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.mdx index 758109868df..1e5b2cfe03a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index 95d66d849d1..3d638d40635 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 4fe6b7ec05c..2e05ec00e68 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index 76d0cc662c1..86f6435870d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.mdx index efece22ad9e..c2d12689f6d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: `ABC` Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.mdx index 770de98007f..17043c2864a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: `object` Result of QFI. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.mdx index 8025568b409..a21d83503ea 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: `object` Result of QGT. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index 8525a04da86..20f457c847f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.mdx index 7b5d339b1b2..c7cd8febb79 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 04f73d2fdd4..8cc0e31067a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 413eeea7efc..657ed993c54 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.mdx index c9f52f5d11e..46e88796b2d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: `object` Result of SamplerGradient. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index d88efbccf80..7812e097615 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The Adaptive Variational Quantum Eigensolver algorithm. @@ -104,7 +104,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index 27ead90b92c..ac968a372d1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index 99972744b1f..d2749558458 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: `ABC` The minimum eigensolver interface. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index 3544a08cbbe..a20d11c11da 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 4e6475c2faa..a046d3df98c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index f87ba874ab8..f784ac75e91 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 3f4bb46efc2..972fc46bb19 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -145,7 +145,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index 5d5557e3992..b0c3020ee0e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: `ABC` The Sampling Minimum Eigensolver Interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 29bd42bf6fb..1091afe4764 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 8a6b3fcc96f..1180fb427d4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -141,7 +141,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index ec2bf0be71b..3c4991d79d6 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") VQE Result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index fd21c4f2cd5..7754a46c28b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The variational quantum eigensolver (VQE) algorithm. @@ -147,7 +147,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 8db19f31316..5a26985bf52 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.mdx index 511ba223c4d..aedbed51dd8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -57,7 +57,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -176,7 +176,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.mdx index 0def1e18b74..c8ca9b24871 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -59,7 +59,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -135,7 +135,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.mdx index e27161a28fb..1a0370ae44b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: `ABC` Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.mdx index 8360fedce6b..2cd5e134bb9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.mdx index 258d1e159af..b52a4bce62f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -118,7 +118,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.mdx index fa57b70f9a5..03a6e669080 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -40,7 +40,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.mdx index 2f941c6b1c7..873292f8ed6 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.mdx index 9648c299f04..5610fb61dad 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 11b11667b23..13bc7579cac 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.mdx index 34aeaa37143..e8a6deef94e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `NLoptOptimizer` ESCH evolutionary optimizer. @@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.mdx index cee6d410e20..88d4d06c288 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -80,7 +80,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -236,7 +236,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.mdx index 60d2b820b3f..e6b2a1ccd8b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -218,7 +218,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -338,7 +338,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.mdx index cafd4507dad..5aef017087d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.mdx index 0772c5f20f5..c2aa0391d2e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -39,7 +39,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -115,7 +115,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.mdx index 54611fc851e..761f9bf53c1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -51,7 +51,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -127,7 +127,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 850d2dab44e..92c666684e9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -124,7 +124,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.mdx index b1d21f3b566..fc06375da80 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: `Protocol` Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 971e31f9842..5e8eca39c71 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -46,7 +46,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx index 4432da14fc0..cbda3ac733a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -50,7 +50,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.mdx index 06347935e17..489e7c409c9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: `ABC` Base class for optimization algorithm. @@ -21,7 +21,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary @@ -29,7 +29,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -52,7 +52,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.mdx index b33e378a7ab..ac7db604da4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.mdx index a9b699a6883..ae451f32248 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: `object` Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 1d963f4a885..17905ef2ced 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: `IntEnum` Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.mdx index 6dade0253a9..839ecda26d1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -117,7 +117,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.mdx index ac56c803a69..24a21235deb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.mdx index 81478663548..25c185d027d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -139,7 +139,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -151,7 +151,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -202,7 +202,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -308,7 +308,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.mdx index d0e8a208fec..4aa0449e68f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.mdx index 96ef465ac39..542d38fe9c0 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.mdx index cf4c292202a..2ba4f976c75 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -167,7 +167,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -187,7 +187,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -293,7 +293,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 7fb2ac368d8..109f81ee0c4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -112,7 +112,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 9e3b31e36a9..85542ac07a6 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -108,7 +108,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](qiskit.algorithms.optimizers.SteppableOptimizer#step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -148,7 +148,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary @@ -156,7 +156,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -274,7 +274,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.mdx index 152586650f0..bca5572e414 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -45,7 +45,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.mdx index d532fc35365..f02b43620cf 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: `ABC` Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.mdx index 429be9a370c..292d529c8dc 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -94,7 +94,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -170,7 +170,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index fd862e33b74..4c4539c4e1f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: `Generator` Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index 394a8eb0932..13d4ac2bd67 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: `ABC` An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -25,7 +25,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index a553a7b4df7..1065fe3fb6d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index f8380cd0dcf..12ce89a568f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: `object` This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index 76c7c221f93..7d8af87cb2a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 4a2521057f0..aa47a45d620 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index 605e49055fb..cc0bc8da45b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index ed230a6b91a..adf646b22a2 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `ABC` Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 9223a86dc27..265f2748e75 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index 0ce114e7e1e..34eb7514461 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `ABC` Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 8051f451f7c..98d1321ad60 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: `ABC` A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.mdx index e8bc86e7e11..f076e11afda 100644 --- a/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: `SimpleNamespace` Class for Run Configuration. @@ -69,7 +69,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.mdx index 6c5a3ac8f74..4826b79790f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.mdx index 05e56ccb1c8..0906874b20d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Bit.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Bit.mdx index e4cf969a008..bd826d248e6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Bit.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Bit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Bit # Bit - + Bases: `object` Implement a generic bit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.mdx index 085b7968b6b..723aefdd0d4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.mdx index 379bbef78ba..088b4ca4387 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: `object` A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.mdx index 9026d807f06..d4d914efe1d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Clbit.mdx index 876e686d239..040e8470040 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a classical bit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.mdx index 8102082b951..04907dea790 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.mdx index f48ab5f2f69..d3f2abec7a8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `ABC` Abstract class to encapsulate all control flow operations. @@ -171,7 +171,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.mdx index 8c6224e09f6..0b4f75ca428 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Delay.mdx index b0c8b36379f..f671db3c138 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.mdx index 1e477672b14..4e8eca4fbfa 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: `object` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.mdx index e2c5d017f24..f22fa51e730 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Gate.mdx index e85d8a35c87..d744288c999 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.mdx index 5adb8242147..8039575144b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Instruction.mdx index 2a25bea153c..7e000efd6e1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.mdx index fcb1368040c..0e2db907865 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: `object` Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Operation.mdx index fad31ae2672..0cc5bcef1e0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: `ABC` Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Parameter.mdx index 47c6526d128..7e56ac538a6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.mdx index e2fd6e1f51e..096a51259f3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: `object` ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.mdx index f76b4bb0fe7..b440fae4e18 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: `object` ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.mdx index b434c164b48..c0e859fdd08 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: `object` Create a new circuit. @@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -441,7 +441,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1293,7 +1293,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1318,7 +1318,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Take in a QASM file and generate a QuantumCircuit object. **Parameters** @@ -1338,7 +1338,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Take in a QASM string and generate a QuantumCircuit object. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.mdx index 6e538425d6d..a0d5de9c024 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Qubit.mdx index 89a1abc362f..c3fe2b83465 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a quantum bit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Register.mdx b/docs/api/qiskit/0.43/qiskit.circuit.Register.mdx index 2bfb78465d2..4155ba38d45 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Register.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.Register.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Register # Register - + Bases: `object` Implement a generic register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.mdx index 5817e1fb157..ebb57e0c032 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp # SwitchCaseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value `CASE_DEFAULT` can be used to represent a default condition. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.mdx index 798ff295c71..701eec537f4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 8efb8e1ce26..483b2c8afe6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `ClassicalElement` The Boolean Expression gate. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index aa9653c21be..7729ebf2285 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `ClassicalElement` Represent a classical function and its logic network. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 85740abb2e4..1fb04e528c1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 7b1fb68d50e..4985ce02146 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.AND.mdx index e5017527d3d..f794b815744 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.mdx index 8d05a33060e..4f4bc960d02 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.mdx index f9389d04773..35e09eb2437 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.mdx index e2057ed42a6..5ed2dbfe554 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.mdx index 66c8916e4fc..07c3d0c7163 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.mdx index 850abc8eecd..cf6cd06f9e2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.mdx index 0a50e8cf17a..bcbd1e192b7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCZ gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 4b3a37ca304..3e89c4982a1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.mdx index b6ef502044e..6b56196255e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.mdx index af85a09f038..44f14e122ea 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.mdx index 2a1f71b92ce..f799fd8db60 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.mdx index 39ca2ac7e9d..633d43b260f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.mdx index db39f57c77f..75f231e454c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.mdx index 8b74e8146ff..763741b801a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.mdx index c7d69cf339b..6eb28ea7b94 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.mdx index d7d7c0f98be..4cf8b78b985 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.mdx index 3a6daedf61a..9d33041e913 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.mdx index 0dc1409c291..c92506be22f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.mdx index 86356b6214e..6cb60b45e3e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.mdx index 7929e0f271e..80daec86385 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.mdx index 329f5e1f6b7..5de873673ca 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.mdx index 50d1a55ac81..3af4ac6153e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.mdx index c5dafad721e..d66b6badeb5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.mdx index 6d520eb570c..b0ab073d878 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.mdx index 44b88e9f9f3..eee09a34d55 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.mdx index 64a9bbb17b0..e98440d8215 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.mdx index 48c08de3fc0..a612ec5b601 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.mdx index a5e43c764fe..e9152a8b321 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 401a0332fcc..4caa6778e87 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.mdx index 4dd1916349b..d7a745cc609 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.mdx index 3b28ebebd7a..a756d91b223 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.mdx index 38c8a779c4c..e298c8cf67d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.mdx index c59a9887fa6..9f1dfeb39b3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `BlueprintCircuit`, `ABC` Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.mdx index 6dc03131aa0..fe54896e511 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GR.mdx index 67e6f64ba43..bb547a27fd2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.mdx index 2c94dc8dae0..9c80ad64e73 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.mdx index 2002a8cac86..4312b4f881d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.mdx index 125836b572e..2b39783fbe5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.mdx index 25c17d8837e..8b2f120f46f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate # GlobalPhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The global phase gate ($e^{i\theta}$). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.mdx index 4ce97e23089..8ca873a44aa 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.mdx index 15585d99205..d21b2157b4e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.mdx index 0ee62ddfd53..6f43a3cd8a7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 14d0bf9d964..5f849619134 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.mdx index 370bf40a702..f5a6f8b46bc 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.mdx index ebc5f044c33..d0b33184075 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.mdx index 4a8bd9c9f19..965f490e931 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.mdx index a9df7c7471b..62ad09c366b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.mdx index 96fe45c749b..b58d4c6a611 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.mdx index c31e0a15767..882938e8af5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.mdx index 5861fcbc119..2bc25146c9f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.mdx index 2f94f878e17..52b0eeb437c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.mdx index 6fe49aaec49..f3f6432a4ea 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.mdx index f72b56d5e29..8f3e5e4820a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.mdx index 9c980978ef8..e35412f499a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.mdx index 455b86ca2e2..a6220e88db3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.mdx index 4f29fb71e90..d810189fdd0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.mdx index 01fab5f7138..84bd3f53b89 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -23,7 +23,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.mdx index 19614dcd411..31ce281aba0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -21,7 +21,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.mdx index 30b82a1950c..e0bc395c5d7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.mdx index dff3c44f4b6..3f442baf349 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.mdx index 846862433e3..9cacc1daa82 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.OR.mdx index d5421d5190d..631bf9778f3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.mdx index 9ee7fac6584..76c8a2c8ac3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.mdx index 114848ed922..b18892ec393 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.mdx index c79b8e26f52..aed4d175385 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.mdx index 251928b4b74..39accdbbae4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.mdx index 148ecf329bb..bf7c2f6e773 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.mdx index 3ce20505586..2a0a3ffb511 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.mdx index f8ea426c466..954cbd1b8ad 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.mdx index ca05c2bcc3e..27fb9a2b8cf 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.mdx index 0005093f4e4..8f9066ad8e6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -53,7 +53,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.mdx index d552ab43559..b10fccc7f2a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 73c70409db5..721b6d9bd43 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 64e0ef2a176..1e17ccc8257 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.mdx index 2149f3ed18a..ab4e503f1a9 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.mdx index 60eea8cb14d..de1f0d4d4e1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.mdx index be7fb4cff26..a80102635e8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.mdx index 319acc6ddc0..738a248f26d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -58,7 +58,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.mdx index f24666ec2b6..e71cc12c19b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.mdx index 557cec9ec05..dc26b0d3d90 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.mdx index 9627e8105a6..cd24f72120e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.mdx index 5160079cd2b..27fc9d5d2dc 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.mdx index d686e051155..edc6fdfb1ee 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.mdx index 39df747ae30..00bf2753a09 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.mdx index bd7cab335cf..0110378e281 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.mdx index e9fafcb782a..f2c46240901 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.mdx index 0185269a324..7cd97faae61 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.mdx index b1508aba6c0..fd4fc53b18a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.mdx index d57d78373a7..f14627a186d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.mdx index b24f83332ba..a1adb762bb6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.mdx index 81386bf60de..87d6b30c756 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.mdx index 2291776be05..f5095c86089 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.mdx index cfcf9f0eee2..bfcca6889f4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.mdx index 60d63d177c6..08027e08cbc 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.mdx index 017303deaa6..4f9a7141dda 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.mdx index 4469a6652b9..1703ef35ae8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.mdx index 44bc41093d5..0f3c087f267 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.mdx index 3a41c84ede9..d474933fc61 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.mdx index 86cca9da7b9..787bcc6c775 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.mdx index 90254a27206..fdd2e557d7b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.mdx index 0e3def0d7b8..8748cf78f09 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.mdx index be333ee10cc..a2354e7663d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.mdx index 5c2dc3b211f..3f79ad3242c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.mdx index 4d7d6dfb164..1f1b8b39a3d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.mdx index fd3abbf6f3b..89fb2069fef 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.mdx index a8f1ad04a4e..5bdb8342324 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.mdx index 720e06afc3f..1ddfd4b1bd3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.mdx index 13a4f5071e5..d5a2e989063 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.mdx index ac0965a51b1..18fa49ccb6d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.mdx index afbac69342c..c3d176ad43d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.mdx index 32274c55640..cb51eed7f98 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.mdx index fec58c39ddd..c47fa821a4e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.mdx index ea224d0b690..948d6be51f1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.mdx index 112615f66dc..ec1d0abe88e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.mdx index 238e9d958ea..d8d6b012639 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.mdx index d4c76011c51..2a3723b7970 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.mdx index 4e25471518f..20260482945 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.mdx index 8e1421c9708..bea888bd2fa 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: `object` Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.mdx index 6f85b8e5685..4f8656b7562 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError # qiskit.dagcircuit.DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.mdx index ca9bbfbdf90..5fb5a2d6284 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: `object` Object to represent the information at a node in the DAGDependency(). @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.mdx index c57395a6dde..8d9bb5c4b86 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: `object` Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.mdx index 39ddb49ca18..0ad12143f91 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.mdx index bdee2bb4d32..9220db63a3a 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: `object` Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.mdx index eb7b0ed5a27..42a1380ea6a 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.mdx index a09e88272e6..1198c2e83f6 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -21,7 +21,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.mdx index 4dad05dd3c6..e79daac1706 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hamiltonian operator as a gate. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.43/qiskit.extensions.Initialize.mdx index 5a26c54586d..13c890fa52c 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.mdx index 7c892cdefdf..a6429a30e93 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") u = 2\*2 unitary (given as a (complex) numpy.ndarray) diff --git a/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.mdx index 30b7ad3da38..f5f461fb69e 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.mdx index 8e291614b9b..d8903eb49f5 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.mdx index a5a348350d1..5eaf6566062 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.mdx index 66fafdb5013..d7489be8d9f 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.mdx index 0ac46201b77..f05ea6a36b6 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.mdx index ef136ff7f49..42949332415 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.mdx index 92afe36459d..14634fac22b 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `StarAlgebraMixin`, `TensorMixin`, `ABC` Deprecated: A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -25,7 +25,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -93,7 +93,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -133,7 +133,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -153,7 +153,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -189,7 +189,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -225,7 +225,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Returns** @@ -265,7 +265,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -301,7 +301,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -321,7 +321,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Returns** @@ -349,7 +349,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.mdx b/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.mdx index 55aa9be6815..b4ef4414f68 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError # qiskit.opflow\.OpflowError - + Deprecated: For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.mdx index 18b25ce4294..1c64b9d035d 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -49,7 +49,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.mdx index 21da87b7642..08d89e4e7de 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.mdx index 7b13cb4e6b1..99ef1298f5f 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: `ABC` Deprecated: Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.mdx index a3acaa4957d..718e67e4a46 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.mdx index 9a149935aa9..d4f148f2af3 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -175,7 +175,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -196,7 +196,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -238,7 +238,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.mdx index 34684d9dcc6..623ee1752e1 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.mdx index 098fc474125..4e030df97d4 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `ABC` Deprecated: A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > #### Args: diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.mdx index be08473e2ca..59bb6a1af75 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: `object` Deprecated: A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + 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.43/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.mdx index e1d32074ed9..0224b809423 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.mdx index 20d9c44f4ad..93b8c51aa09 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 8290d504245..86f18f2ae80 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.mdx index 0c22d257e1a..0de6519071b 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.mdx index 8f261d34f78..9c13210155f 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.mdx index 48cee204986..1887b1d84eb 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Deprecated: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.mdx index 2f21165c35b..01a82aae68e 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.mdx index de43ecf6b22..7cf436a7053 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: `object` Deprecated: A factory for conveniently creating TrotterizationBase instances. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.mdx index e17330f94a4..356c0ce1845 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.mdx index 554224aa2a0..1014964fd8a 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.mdx index ea97ae43b77..6481a620814 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,7 +23,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.mdx index c814c1d4ac8..9f9ad10bd3e 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: `object` Deprecated: factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -19,7 +19,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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.43/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.mdx index 5f8bb72689c..c8a362c47bd 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.mdx index cd1e311b6fa..6d6c41b8c2e 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.mdx index 8678b40cfcd..8a55df0f1f3 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to gradient operator converter. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.mdx index 77adc5eaf8f..a4033e6b23a 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to Quantum Fisher Information operator converter. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.mdx index 92c94be52c9..9d70f01a444 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Base class for differentiating opflow objects. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -76,7 +76,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.mdx index 1468578ba26..eab37de6e54 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.mdx index f4b5e422561..74b816e5bdc 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.mdx index 679566296f6..6561f703a13 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Deprecated: Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.mdx index 079acb315f4..2fcf792d0e8 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.mdx index 3ee511f1c7a..074f42d56a6 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. @@ -65,7 +65,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.mdx index 78e9bf69a68..b0fa5cdea35 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Deprecated: Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.mdx index 185c16b09f2..50085969636 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.mdx index c0634f5e4d9..0c47498ff87 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.mdx index d895effc23b..d1efe880040 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. @@ -122,7 +122,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.mdx index 9dbde51349d..7a9411f9963 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.mdx index 42778df9880..8a81b752353 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.mdx index 1eea0e42b9d..f0d9d2c5069 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.mdx index 65b5f40aa4a..6c2ee0f1976 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.mdx index 8abf0c2963f..9999a86628e 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 7ccd8a26879..0e6642dc18e 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -151,7 +151,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 1c1fd34c57c..32b6f8d3252 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index e51bf060f61..c3a0e0c8812 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Deprecated: Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 78d56c028b8..d914a76de11 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: `object` Deprecated: Z2 Symmetries @@ -95,7 +95,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.mdx index d02edb7c465..72b8eea5b8b 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **Deprecated: A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.mdx index d0b78e78c0c..221f8b9232f 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -138,7 +138,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -158,7 +158,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.mdx index 8b8a1aecf32..1ff3c2bce74 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.mdx index cbee1bebb79..b4333339da5 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 992bc7da57c..765ffe4471d 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.mdx index 253a1037f95..851ad051de9 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.mdx index 2e327328c2c..3aca1630952 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.mdx index d1453077a47..dd5559eaa14 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.mdx index 23f5d2a7551..b9560941ff1 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.mdx index 04be3ccbdde..b7501996d17 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `BasePrimitive`, `Generic`\[`T`] Estimator base class. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.mdx index ef685c263b7..04b623bd43b 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `BasePrimitive`, `Generic`\[`T`] Sampler base class diff --git a/docs/api/qiskit/0.43/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.43/qiskit.primitives.Estimator.mdx index cc2069103ff..9c4299f3e28 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.mdx index cc7d51207a4..f140d336802 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.43/qiskit.primitives.Sampler.mdx index 2f239cbc130..36a2e2ff4df 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] Sampler class. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.mdx index 25af69cd6a3..b256e1209ef 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.43/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.43/qiskit.providers.Backend.mdx index 8931b90e654..b7d515a8cdb 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: `object` Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.mdx b/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.mdx index ed3f142ba5d..cc2857e942f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError # qiskit.providers.BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.43/qiskit.providers.BackendV1.mdx index 9e4360a6b94..6fe2695c96c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `ABC` Abstract class for Backends @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.BackendV2.mdx index 04760d06398..04034b55209 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `ABC` Abstract class for Backends @@ -162,7 +162,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.mdx index ba8d41d22f1..ad91f3c25a0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.43/qiskit.providers.Job.mdx b/docs/api/qiskit/0.43/qiskit.providers.Job.mdx index ed69a667702..d63380ba19c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: `object` Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobError.mdx b/docs/api/qiskit/0.43/qiskit.providers.JobError.mdx index 57a8d7f249a..ec917f6e707 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobError.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.JobError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError # qiskit.providers.JobError - + Base class for errors raised by Jobs. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.43/qiskit.providers.JobStatus.mdx index f07bae58caf..1105b546633 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: `Enum` Class for job status enumerated type. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.mdx b/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.mdx index 4dc80f78e76..5b34210607a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError # qiskit.providers.JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.43/qiskit.providers.JobV1.mdx index a13fdf76058..d2eab4a3907 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `ABC` Class to handle jobs @@ -97,7 +97,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -117,7 +117,7 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ python_api_name: qiskit.providers.JobV1 ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.43/qiskit.providers.Options.mdx b/docs/api/qiskit/0.43/qiskit.providers.Options.mdx index 1eabe4eeef1..bac22bb9645 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: `Mapping` Base options object diff --git a/docs/api/qiskit/0.43/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.43/qiskit.providers.Provider.mdx index 10b7829a7d3..7d1882bef5e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: `object` Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.mdx index dd6d5a32113..c094c23699c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `ABC` Base class for a Backend Provider. @@ -19,7 +19,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.mdx b/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.mdx index 8de97999cca..7f0c0d9838e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError # qiskit.providers.QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.mdx index 901b815b971..bf4d62c8a83 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: `object` A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.mdx index a019c9c2d69..fe2ca1322b6 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.mdx index 3909dd357f2..4109d23776e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.mdx index eb4577c6e2c..83e9be529a1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 3041928c6d5..88a287df3d2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a qasm simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 12220054923..044eb432688 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index b4df168d06d..874428ab1b3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 0aec777f6ed..39fb748ede2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.mdx index 68843e7ca9c..bfd6d8c1c77 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.mdx index 9554ec1822a..8d6732b924d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index 6d15a24256f..078127f751a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.mdx index 57b7943afd5..a63ad638e47 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 702f448a000..2468704e9f1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.mdx index fe49ae6d9b7..25a6fa38e76 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.mdx index 99c3f61ec2c..05c0bef467a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.mdx index d6f9ed53d12..fb3c5b083e1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index a3b726843fd..3f94eab9682 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.mdx index 27bcd9b51a1..e5e42c73a40 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.mdx index bd7da03cb6b..2008d1511a4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.mdx index 6d416a81164..ae24fc32268 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.mdx index 35a7770a99c..1a528a6137e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index 41c2e3207e7..02b25756056 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.mdx index 3e0c78bbb73..d167b0f2eab 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 0f62eccbcb4..828e8e01b56 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.mdx index d3c9b5d9945..1925a409d8b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index f858792edda..ea789be0bbf 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.mdx index 1fc8733723b..44d985336b0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index bee3d1ce308..cbf6f81a723 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.mdx index f313c319db6..de381ec7955 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.mdx index aa538cf7c92..46f20641a2c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.mdx index 9593ff87c73..0b37e597e96 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index e07cccdac45..82340287e60 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.mdx index 4e0b45ad908..2a0bb607b9f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index dfa3e2f4c12..f391732b3b4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.mdx index 3bbc04fba2f..031bda0fb07 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.mdx index c73bf2aa2f4..d75af02b358 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.mdx index 183d6c911ef..20f40664f87 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.mdx index e8181867160..648745ce998 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index 23f0fe652be..156ad2171fe 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.mdx index 429f2aa0d2d..ec386d71515 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.mdx index b26f647a248..c241d345801 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.mdx index 32a65c8ce1b..77a20adfd2d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 614f338866e..baa1d8cc9d3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 229dd940504..37ab9b42b04 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index f30e43692c0..55f3ef46679 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.mdx index 025d29eb994..3733877563b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 0e9520c26f0..44d05d49aa1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.mdx index 319e4e3eb5e..57f9073341b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.mdx index 99605eedef5..441e567deb1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.mdx index 997d7483ff6..7ec22e88ca3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.mdx index 71952a7d534..9323929f04f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.mdx index 68a9daf990d..a0d46556dc6 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.mdx index 2307ba93759..e18eadeb61d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.mdx index 6462fd17665..4a6cc34cf2d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.mdx index df80238cf36..e7d6a28375d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.mdx index e52e6a33075..1a8fe908bbb 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.mdx index 9e04f608389..51c9709f1e6 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.mdx index 0b01944bd1c..60ffe11b1f7 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index 17c2dc9ba09..85bc4be969d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.mdx index 6bb8740b781..ec3b38d56f8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 8bc8fb26f95..b9452e15416 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.mdx index 28a759f4c0d..a91fd8e99d0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 666f7fca7ea..addd83be345 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 020f80f08d6..e3f78cdad07 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.mdx index 78499d3f8a0..392cc09fdc1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.mdx index c4163b2aa66..4e6df954719 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 79dffc56688..9e419ee4acb 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 004c3455ec5..c402ad923f8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.mdx index cb68d45c3b0..3f0b0cd78f9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.mdx index e27fb052d2a..f5d14e1554a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.mdx index eaca3b5c3c7..708e523e8c7 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.mdx index 6f9b59a6483..c1b5d61367c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.mdx index 1a9c92207b2..d126648eaf4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.mdx index b46d5bbf956..8fd95fc8434 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index 24315ba3331..926c3d68c78 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index e47126e584b..eb43b53d650 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.mdx index 090293384c1..5bf4a444cad 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: `FakeBackendV2` A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.mdx index daf2f9643c1..d383f3da622 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index f2a997de24b..db4e22f078f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index 0037e45001e..0c8e9cbf792 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.mdx index bd43daffb4f..84f6729af5f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 4858a9e54b2..95d07875bcd 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.mdx index 30fd31bf135..bf5b8e2a970 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 95d394e5360..d1093b4a180 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.mdx index 4db9f90ecd1..da2be6e5a8a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.mdx index ee70468314f..a4a651b700f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 67c379f5125..a5f890a17e1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.mdx index 76e15620545..ca9cc712fba 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index b90a58e0f2a..bbbc710768d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.mdx index 75d07c298c7..b972275e35b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: `FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.mdx index bc9d581327c..feda75bc5cd 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index 84bdbd96b88..51b7460a0f9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.mdx index af76f776dad..1be63711252 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.mdx index 6617b13d66a..8eba5c56eda 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.mdx index a963c9d97ca..6da9431567a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.mdx index 424f6875363..ee353159541 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.mdx index ff78bff310f..b82a64ef0c2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.mdx index e68143bec65..632c1b8f27e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.mdx index c28e33f2208..515fbb84eba 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.mdx index a7b2353d359..b5cd7ab73bf 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.mdx index ee0ac26e2cc..4d293c0dbc8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.mdx index 93d3bdc2b6e..46e3c2b22f5 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.mdx index f424f5b2244..40db16bd26a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index bb5f16472ef..e45c4e6357a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.mdx index 71936e45331..4e8d0c8b49d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.mdx index 00b4b9e6610..a691fe96358 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.mdx index a7c45b0f30c..7b58d9d7023 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -91,7 +91,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.mdx index 5488cb90ad7..87f1617c772 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: `object` Class representing backend properties @@ -69,7 +69,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.mdx index 6400f772b72..b8fe3d2ef91 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: `object` Class representing Backend Status. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.Command.mdx index 903a4733d85..1d9f09d24eb 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: `object` Class representing a Command. @@ -34,7 +34,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.mdx index 188c476f401..e8c3dfb6082 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: `object` Class representing a Gate Configuration @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.mdx index e17e1962087..847d277c4ef 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: `object` Model for JobStatus. @@ -49,7 +49,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.mdx index f406248aa4f..a4c902273a6 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -170,7 +170,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.mdx index 88580873f56..74690c3a64b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: `object` Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -21,7 +21,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.mdx index 0b5e44f12fc..645d96d6c40 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: `object` Class representing a Qasm Backend Configuration. @@ -157,7 +157,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.mdx index ed90b2bb6d7..5d27b513a5f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: `object` Class representing a U Channel LO @@ -42,7 +42,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.mdx index e5d46bffb83..70b1224c06d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: `object` 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: diff --git a/docs/api/qiskit/0.43/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.43/qiskit.pulse.Schedule.mdx index 1644f4f112a..4f2a6653e1a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: `object` A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -278,7 +278,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.mdx index b17b219807c..6c995d903f2 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: `object` Time-ordered sequence of instructions with alignment context. @@ -440,7 +440,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.mdx index 2588c4f69b4..48e3bd226b3 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.mdx index dfd639033db..a60fa66e0ac 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.mdx index 0e942620f60..306ede56281 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.mdx index 256e701b9b3..ad0c105dc28 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.mdx index db2c98e0f9a..fb80b113f54 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.mdx index b3fcd121ab1..390a2daad39 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.mdx index 12581bebe0b..653cf19b4ca 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.mdx index be95d1a774a..6781e72af81 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.mdx index 5f016620c27..62b24974a3c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.mdx index cf0342a74ad..617c3425828 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.mdx index 4f0e6dd3b73..201c0e4ac5a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.mdx index fca355d4b14..71174d50720 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.mdx index 9ab8fe38080..1d59c874777 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.mdx index 5551fb1af3e..857c5ed186b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.mdx index 0c8473ce83c..3bc761b7f30 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.mdx index 4f6b2c97d31..7d9c17f4f31 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.mdx index 3921738aa47..c0e24d51305 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.mdx index c312401b6cc..0cb59787f07 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.mdx index e2bcc1167c5..1d041c9423b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.mdx index 18844dcd0e0..9d7ec588edb 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: `object` A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.mdx index 6f87ac8761b..96ae1aec29c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: `object` The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.mdx index 1a1005014d9..6914171e7db 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: `object` A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.mdx index daf818c70cc..395f0dda3ae 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: `object` A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.mdx index 86f954ee8f5..ef866697e42 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `Pulse` The abstract superclass for parametric pulses. @@ -73,7 +73,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.mdx index 2bdc86dc1d6..2512654be7a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.mdx index 1c870916657..df06a602347 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.mdx index 5ec970be3e5..e82d43feb4d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.mdx index 6d1b5027099..edd2772db3a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.mdx index 54b774b1053..3dd5ac66a7d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.mdx index ccd2014a3b3..e8529b42eaa 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.mdx index 749f7b016bc..8e3bf8b6da9 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.43/qiskit.qasm.Qasm.mdx b/docs/api/qiskit/0.43/qiskit.qasm.Qasm.mdx index b57f00348b5..52508036b94 100644 --- a/docs/api/qiskit/0.43/qiskit.qasm.Qasm.mdx +++ b/docs/api/qiskit/0.43/qiskit.qasm.Qasm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qasm.Qasm # Qasm - + Bases: `object` OPENQASM circuit object. diff --git a/docs/api/qiskit/0.43/qiskit.qasm.QasmError.mdx b/docs/api/qiskit/0.43/qiskit.qasm.QasmError.mdx index 1e0b97a0f46..d10e143cb36 100644 --- a/docs/api/qiskit/0.43/qiskit.qasm.QasmError.mdx +++ b/docs/api/qiskit/0.43/qiskit.qasm.QasmError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError # qiskit.qasm.QasmError - + Base class for errors raised while parsing OPENQASM. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.mdx index 3ac74bf96b6..9100884443a 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: `object` Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.mdx index 11dc26c5d8b..ecedda2dc59 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: `object` An item in a pulse library. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.mdx index 49e823c2fe7..61ada0ea273 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: `object` A Pulse Qobj. @@ -30,7 +30,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.mdx index fab6c5d1a37..d7c61b77757 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `QobjDictField` A configuration for a Pulse Qobj. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.mdx index ef2adda2756..30778236285 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: `object` A Pulse Qobj Experiment. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.mdx index fe8c41cbcbd..05625cd541b 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `QobjDictField` A config for a single Pulse experiment in the qobj. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.mdx index ae7b68c1cf2..27632658689 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: `object` A class representing a single instruction in an PulseQobj Experiment. @@ -41,7 +41,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.mdx index 614623983ec..dc3aadb9324 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: `object` A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.mdx index 67caf7f9f03..fbc6cc31027 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: `object` A QASM Qobj. @@ -30,7 +30,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.mdx index 3ebaef6f8c8..582c3e8ce6c 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: `SimpleNamespace` A configuration for a QASM Qobj. @@ -38,7 +38,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.mdx index 7e70e4e9007..0163f59b851 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: `object` A QASM Qobj Experiment. @@ -29,7 +29,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.mdx index b7fe2046c2d..85082100640 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `QobjDictField` Configuration for a single QASM experiment in the qobj. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.mdx index e8bee93e1c8..b66f7f6b806 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: `object` A class representing a single instruction in an QasmQobj Experiment. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.43/qiskit.qobj.Qobj.mdx index 42dfd508025..364638c2551 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.mdx index 081c6211b45..75e5c5babf4 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.mdx index bd9275a9edf..31aa83e904d 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.mdx index 9fe955c9c28..d2d17013406 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: `object` An individual measurement option. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.mdx index d289501d858..a0933f95982 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.mdx index d55c605519f..550d2355580 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.mdx index dbefbc29dcf..1c8d48937ec 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.mdx index 9e3f00f6904..5a577d37884 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -175,7 +175,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -199,7 +199,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary @@ -207,7 +207,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -257,7 +257,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -283,7 +283,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.mdx index a7bfc1930d4..c3c6a57f991 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -166,7 +166,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -192,7 +192,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -220,7 +220,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.mdx index cbc4cea80ae..f6d2a997d10 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 7258cdba371..48af681ca4b 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: `object` A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.mdx index 707dee8bed2..c4ca3870b4c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -197,7 +197,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -224,7 +224,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.mdx index c3e2a6ac01b..6df2ccf483e 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.mdx index dd73cf3b934..9f2b474328d 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -432,7 +432,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.mdx index e95d8ba0422..1ab07bc95f5 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -398,7 +398,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.mdx index ff43b956251..aadc6b03369 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `BaseOperator`, `AdjointMixin` DEPRECATED: Symplectic representation of a list Pauli matrices. @@ -356,7 +356,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.mdx index 1db2d9be8e6..060dad847f8 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: `object` A class representing a Quaternion. @@ -19,7 +19,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.mdx index 13f7b6dc7a3..c6688d6265d 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.mdx index 85b0693f0fd..a5a92e15287 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -310,7 +310,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -348,7 +348,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -376,7 +376,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -679,7 +679,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.mdx index 72c901b7051..7577d05fa44 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.mdx index cf43ab4f435..b28bc57d579 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `AdjointMixin` DEPRECATED: Symplectic representation of a list Stabilizer matrices. @@ -389,7 +389,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.mdx index c4486d148a2..3a64ab81e8c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -209,7 +209,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -235,7 +235,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -263,7 +263,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.mdx index a492c90e338..01ad113411d 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.mdx index 9a275b978ce..9faca8d765c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index b87291da5e7..970b2b73807 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: `object` A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -26,7 +26,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.mdx index 9b4291e9dca..3ed5687182b 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: `object` A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.mdx index 1d607becb95..df937a3b799 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - + Bases: `object` The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -79,7 +79,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries ### find\_z2\_symmetries - + Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.mdx index ec05f518d13..69a2af1dd78 100644 --- a/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: `ABC` Base readout error mitigator class. @@ -19,7 +19,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -43,7 +43,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.mdx index ad9d2ad53e6..b9c53a9fad2 100644 --- a/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.43/qiskit.result.Counts.mdx b/docs/api/qiskit/0.43/qiskit.result.Counts.mdx index 0a33565a7d1..3f1ae612ffa 100644 --- a/docs/api/qiskit/0.43/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: `dict` A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.mdx index d947e240c30..a958de46073 100644 --- a/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.mdx index 7d367900741..dbd134810a7 100644 --- a/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: `dict` A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.mdx index c85471fa9d8..5b47d29096e 100644 --- a/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: `dict` A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.43/qiskit.result.Result.mdx b/docs/api/qiskit/0.43/qiskit.result.Result.mdx index 89667c61aa9..1cb465cc485 100644 --- a/docs/api/qiskit/0.43/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: `object` Model for Results. @@ -113,7 +113,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.43/qiskit.result.ResultError.mdx index a2d2db95de5..a74d7e3a3d2 100644 --- a/docs/api/qiskit/0.43/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.43/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.mdx b/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.mdx index 14ad6447886..147aff493ab 100644 --- a/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig # ScheduleConfig - + Bases: `object` Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.mdx index 8965bee989a..47073771dd7 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: `ABC` Interface for evolution synthesis algorithms. @@ -19,7 +19,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.mdx index 4d0ec2b430f..20da5bff1dc 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.mdx index 36b7ccb1d90..7c73f07db51 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.mdx index d173e3a451e..4dfa9ee7c1b 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -29,7 +29,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.mdx index b3f59c842fa..b0c0a681658 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.mdx index e499fa3bf42..74b19616522 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: `object` The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.mdx index e7cd9422ab0..ced26aa7da0 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.mdx b/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.mdx index 9144e6f435b..efcdf058561 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.mdx +++ b/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.tools.events.TextProgressBar # TextProgressBar - + Bases: `BaseProgressBar` A simple text-based progress bar. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.mdx index 829ca02665c..4e54df3ba26 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `BasePass` An analysis pass: change property set, not DAG. @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.mdx index 9557767e6ef..45a83022889 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -32,7 +32,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.mdx index 127374d74bf..fa40fa12ba0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: `object` Directed graph specifying fixed coupling. @@ -163,7 +163,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -175,7 +175,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -187,7 +187,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -212,7 +212,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -237,7 +237,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -259,7 +259,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -271,7 +271,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.mdx index 9e7de206d89..a9bb205b78d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -32,7 +32,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.mdx index 51e68acc73f..efa25ade7dd 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.mdx index b200b226d2e..7a424bf96cc 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.mdx index bd7e614a6a6..fe2feb309b7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: `object` Base class for multiple types of working list. @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.mdx index 4aa69026715..43b564a8f40 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: `object` Helper class to provide durations of instructions for scheduling. @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.mdx index 8adb3b4f9f2..c3002e407db 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: `object` A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.Layout.mdx index c6fa15a0d54..8f98d44814f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: `object` Two-ways dict to represent a Layout. @@ -125,7 +125,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -150,7 +150,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -219,7 +219,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.mdx index 80139936475..1c9e47cccb4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: `object` Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.mdx index bdbdefac8cc..801d26a485f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: `object` Pass Manager Configuration. @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.mdx index 3d57ae9c498..61d585b4d50 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: `dict` A default dictionary-like object diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.mdx index 65b1d2b8ba6..458c3d8c879 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.Target.mdx index ddde65eeaa0..1f8285efdf1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `Mapping` 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -185,7 +185,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"). diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.mdx index 29c7361fdf2..9e043219853 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `BasePass` A transformation pass: change DAG, not property set. @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.mdx index 2f9782c787e..c0eabaed82b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - + Bases: `object` Layout attributes from output circuit from transpiler. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.mdx index 8bec07fd15f..d53da61a19f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError # qiskit.transpiler.TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.mdx index b289c670fd6..e51f87dee6b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError # qiskit.transpiler.TranspilerError - + Exceptions raised during transpilation. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.mdx index ff7d5a8f0d1..f621aa8e906 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 25c1414734b..6ca8dd5c076 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.mdx index 54faed450b1..4d62124358f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 5b384f5db3b..27b59cb0e2c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.mdx index 4225b30f6bf..559e8b783f7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.mdx index 9bbda796ab7..468bd277d52 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.mdx index bfff207acf8..5e563d899a3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 54f549061e8..bc8b37cb1b8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.mdx index e8461a14ec3..03c4c171603 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.mdx index b0b942e1d63..53f756ff7cb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.mdx index 01d216ae0d1..aea56a16763 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.mdx index 77057b278a6..239ecdf191e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.mdx index 50ac2903928..56eadb9c95a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.mdx index 66a6ae8b0f1..aef6bb14ab1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.mdx index 2dd43baf872..3e0ea0be80c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.mdx index da46f25cd86..8a9ccd7417a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.mdx index a874c9801d5..5d52f478222 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.mdx index a47c0f2b146..286309508b4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.mdx index 5aa3a2fa1a8..3b1f491fff2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 9efbe70f36a..a1fbb6cc13d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `CollectAndCollapse` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index cf3a3ae9824..dff4b47b0cb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.mdx index b025733d9cc..1a4969c319b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.mdx index fc76df086b9..19d42f03a22 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index 324a0fe960e..797317af936 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 08da09182f6..7e12e7dcb73 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 7ccddf706da..81718ee7542 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.mdx index e881620d374..85ead4fad9a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.mdx index 9f89eeb1d46..865e0383b45 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index 8881b141552..4c8f98d41cf 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.mdx index f7f37afe7c5..d423633bc96 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 3b5e411a26a..7aa7b9e25ad 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index d8aba1370ed..12d1f0e263b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.mdx index f25986857dd..87c4407501a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.mdx index fc84d692f13..a1a4ffcca6d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.mdx index 4178bc70145..b9d96280c08 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.mdx index db4e7e077f6..3dccd933c46 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.mdx index 6a3660d6b77..4bc087881ab 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 284b0fec7bc..83f38df101b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 00fbfbdca48..4a10dee0136 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 45dd2b540d5..d6f74ec74ea 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.mdx index fcdb838efd1..2d15bb8eb75 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 391e14b4ca2..a8b78774f08 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.mdx index 13cdbe6e9a9..5ea0692e476 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.mdx index 6c874847bfa..d89b0340c2f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.mdx index 4c2d68647bf..d0654f9781a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects using synthesis plugins. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.mdx index 6a3f0e2a1a2..bb1ef9da1ce 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 3ac6cba8f60..ff748cc1004 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.mdx index 5d197effeff..39b10a150df 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.mdx index 0230966db13..27fe9aa9a61 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 07dca5d85fe..8b31bd10c0f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 35af09cac09..a200d6ff488 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.mdx index 66c03e8f841..e397784abae 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 10902bdc4de..bcd451fdc26 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.mdx index f54c3f0d6f0..4c635ce420f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint # MinimumPoint - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Check if the DAG has reached a relative semi-stable point over previous runs diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index f86aba2ff3b..510e9b64d23 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.mdx index a264014282d..4ddf8e68182 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.mdx index 8814181f705..9dc7d22a836 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. #### u3(theta, phi, lambda) @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 2e854c2f405..ec68a12fa55 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 96d2e15fca6..add660bf755 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.mdx index 3392c3c3fba..14ff8d12ff8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.mdx index 7f2ff4cea9e..7acc1355f15 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 5674363f75a..c0eb6a1ab0b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.mdx index 815a5bbfbce..08ee7060452 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index c62b1c8e90a..6d5d7eafbbe 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 39d67013fd1..468352b885f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.mdx index b54b3306a4f..190bf5ad291 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index da76fdb9cba..76a115cbfc9 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 9e406293f36..076f03310a9 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 5687761730c..947702d3ed4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index 05e94912eae..4527e5674d1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.mdx index 9176540656a..32e7c6d5af7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.mdx index 997ed241104..65efb087064 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.mdx index 9c39902b456..28aa554fb2f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.mdx index 22539928d37..5e05c8af1a5 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.mdx index 9298404504f..f703c47371b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.mdx index 0f832c5007f..138534d309a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index b0a6c080b5e..351b913c5ff 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.mdx index 03de5abeb51..18b9a117742 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.mdx index 6fa9385a1fd..7d8561cf1c0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.mdx index 35324580bec..47ddd0510ea 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 3619721625f..032126b4fa0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.mdx index b81908c81d8..88a8d41a11b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.mdx index 4a5a8ea2731..a962dec2bee 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 82effc3971c..a33c3c0a72c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 98682f76987..09a70278192 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.mdx index 6152c85160d..e7c2c64bbdd 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops # UnrollForLoops - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.mdx index ef52d79b967..9ce2b8a82ca 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.mdx index 5c52dbcaeae..80f565a051a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.mdx index df5e15ed8ee..3407fc80f0e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.mdx index bf47778dfa1..4bcf0d8e02a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.mdx index 88b3dac2d39..f6a1f48f16c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index 2f986da34c6..e6c176358c1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: `ABC` Abstract high-level synthesis plugin class. @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 3aedb3ef5dd..de7b9708f6c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: `object` Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 01a1e58015a..2265503942a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: `ABC` Abstract unitary synthesis plugin class @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index c6bc7e2faba..746f718601b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: `object` Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index e3dd2a47c38..62f8c1d9a2e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: `ABC` A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 3c2a1bc0b5e..ce115f41f33 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: `object` Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.mdx index b5e709a7a17..b2e344154a2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: `object` A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 889d9f0443a..3260ec01ca3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 579e4fdfaaf..27ccec628f6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `ABC` A base class that represents an approximate circuit. @@ -24,7 +24,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before constructing the circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index a7f45de9d25..9f170bf0746 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: `ABC` A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index ff2f68ef154..8b30dadd073 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index 81690b9a290..12b685cc9ea 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `ABC` A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index fd370c423bf..3d5bf1839d1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index 1603ebb2337..7b4705fd88d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.mdx index e20a5a34016..2ef7a53929e 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: `object` Deprecated: Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.mdx index 81983e11c0e..c771d486d22 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: `object` Deprecated: Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 4dfa1dfbafe..4d2eb3161a6 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: `object` Deprecated: Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.mdx b/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.mdx index 1ccb72ad568..ed41bda29e7 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.mdx +++ b/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError # qiskit.visualization.VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.mdx index 2c19a698265..ec1ca19d927 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: `dict` Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.mdx index 3c85d7ccc93..97210364343 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: `dict` Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.mdx index 2cfdc11e349..ed4f17a3191 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: `dict` Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.mdx index b3fe29e7c16..bd49be6396b 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: `object` Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.43/utils.mdx b/docs/api/qiskit/0.43/utils.mdx index cf2038a1bbd..4e37b8f8079 100644 --- a/docs/api/qiskit/0.43/utils.mdx +++ b/docs/api/qiskit/0.43/utils.mdx @@ -118,7 +118,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -158,7 +158,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -225,7 +225,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -239,7 +239,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.44/algorithms.mdx b/docs/api/qiskit/0.44/algorithms.mdx index a71bafc7bd2..2e6ddc3f80c 100644 --- a/docs/api/qiskit/0.44/algorithms.mdx +++ b/docs/api/qiskit/0.44/algorithms.mdx @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states. #### AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.44/circuit.mdx b/docs/api/qiskit/0.44/circuit.mdx index 72850665efd..a5c54e5b598 100644 --- a/docs/api/qiskit/0.44/circuit.mdx +++ b/docs/api/qiskit/0.44/circuit.mdx @@ -329,7 +329,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c #### CircuitError - + Base class for errors raised while processing a circuit. Set the error message. diff --git a/docs/api/qiskit/0.44/circuit_classical.mdx b/docs/api/qiskit/0.44/circuit_classical.mdx index 94ddb528798..4f1e8acee09 100644 --- a/docs/api/qiskit/0.44/circuit_classical.mdx +++ b/docs/api/qiskit/0.44/circuit_classical.mdx @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr - + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap #### Var - + A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` #### Value - + A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary - + A unary expression. **Parameters** @@ -91,7 +91,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -114,7 +114,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary - + A binary expression. **Parameters** @@ -126,7 +126,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -209,7 +209,7 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast - + A cast from one type to another, implied by the use of an expression in a different context. @@ -590,7 +590,7 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor - + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. ##### visit\_binary @@ -735,7 +735,7 @@ All types inherit from an abstract base class: ### Type - + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -747,13 +747,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q ### Bool - + The Boolean type. This has exactly two values: `True` and `False`. ### Uint - + An unsigned integer of fixed bit width. @@ -796,7 +796,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. ### Ordering - + Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. diff --git a/docs/api/qiskit/0.44/dagcircuit.mdx b/docs/api/qiskit/0.44/dagcircuit.mdx index 753fbc125b1..5b53ddca2f7 100644 --- a/docs/api/qiskit/0.44/dagcircuit.mdx +++ b/docs/api/qiskit/0.44/dagcircuit.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -42,7 +42,7 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError - + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/0.44/exceptions.mdx b/docs/api/qiskit/0.44/exceptions.mdx index 7d620ababe8..ed3ed865985 100644 --- a/docs/api/qiskit/0.44/exceptions.mdx +++ b/docs/api/qiskit/0.44/exceptions.mdx @@ -22,7 +22,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: ### QiskitError - + Base class for errors raised by Qiskit. Set the error message. @@ -38,7 +38,7 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any @@ -48,7 +48,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError - + Raised when an error is encountered reading a user config file. Set the error message. @@ -56,7 +56,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError - + Raised when the file provided is not valid for the specific task. Set the error message. diff --git a/docs/api/qiskit/0.44/extensions.mdx b/docs/api/qiskit/0.44/extensions.mdx index 1f4c927a74c..9f65f1ef51e 100644 --- a/docs/api/qiskit/0.44/extensions.mdx +++ b/docs/api/qiskit/0.44/extensions.mdx @@ -53,7 +53,7 @@ The additional gates in this module will tend to raise a custom exception when t ### ExtensionError - + Base class for errors raised by extensions module. Set the error message. diff --git a/docs/api/qiskit/0.44/opflow.mdx b/docs/api/qiskit/0.44/opflow.mdx index 06c18f073e5..6ed805727b0 100644 --- a/docs/api/qiskit/0.44/opflow.mdx +++ b/docs/api/qiskit/0.44/opflow.mdx @@ -192,7 +192,7 @@ $$ ### OpflowError - + Deprecated: For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.44/providers.mdx b/docs/api/qiskit/0.44/providers.mdx index 760c3d12dbe..e8c9efa7b66 100644 --- a/docs/api/qiskit/0.44/providers.mdx +++ b/docs/api/qiskit/0.44/providers.mdx @@ -77,7 +77,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. @@ -85,7 +85,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. @@ -93,7 +93,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobError - + Base class for errors raised by Jobs. Set the error message. @@ -101,7 +101,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. @@ -109,7 +109,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendConfigurationError - + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/0.44/pulse.mdx b/docs/api/qiskit/0.44/pulse.mdx index 6c234dec12c..098b168926f 100644 --- a/docs/api/qiskit/0.44/pulse.mdx +++ b/docs/api/qiskit/0.44/pulse.mdx @@ -77,7 +77,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -623,7 +623,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -678,7 +678,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -2774,7 +2774,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. @@ -2782,7 +2782,7 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet - + Raised if the builder context does not have a backend. Set the error message. @@ -2790,7 +2790,7 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder - + Raised if no builder context is active. Set the error message. @@ -2798,7 +2798,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError - + Raised if instruction duration is unassigned. Set the error message. @@ -2806,7 +2806,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError - + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/0.44/qasm.mdx b/docs/api/qiskit/0.44/qasm.mdx index 066e0af9a95..956cf08fc1e 100644 --- a/docs/api/qiskit/0.44/qasm.mdx +++ b/docs/api/qiskit/0.44/qasm.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.qasm ### Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. @@ -32,19 +32,19 @@ python_api_name: qiskit.qasm ### OpenQASMLexer - + A pygments lexer for OpenQasm. ### QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.44/qasm2.mdx b/docs/api/qiskit/0.44/qasm2.mdx index d63789eb490..2ce7e81227c 100644 --- a/docs/api/qiskit/0.44/qasm2.mdx +++ b/docs/api/qiskit/0.44/qasm2.mdx @@ -83,7 +83,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -101,7 +101,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -119,7 +119,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error - + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -129,7 +129,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError - + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -139,7 +139,7 @@ Similarly, a failure during the export of an OpenQASM 2 program will raise its o ### QASM2ExportError - + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/0.44/qasm3.mdx b/docs/api/qiskit/0.44/qasm3.mdx index 743d1736329..5915649c1a5 100644 --- a/docs/api/qiskit/0.44/qasm3.mdx +++ b/docs/api/qiskit/0.44/qasm3.mdx @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -107,7 +107,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -119,7 +119,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -222,7 +222,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.mdx index 49cca2d51b8..2399aaf7777 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.mdx index 9593e7d7405..98374e90cb0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.mdx index 8d4577f0af2..a9fc1f2b8e0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.mdx index abce8880ba0..55c923f9b78 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -87,7 +87,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -111,7 +111,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.mdx index a09d11bd155..b45ae8e9454 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.mdx index 42749b6f4e6..7496865a6b1 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 0553023fa9a..1b24df964ac 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.mdx index fda9132689c..02bdf11d1c8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.mdx index b6abf8e79a4..9e29da3563d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Deprecated: Eigensolver Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.mdx index e26c6be15a6..f490d233387 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.mdx index 22cf3833716..4189e0a9382 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Evolution problem class. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.mdx index 34d9d411220..b6b060da196 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `AlgorithmResult` Deprecated: Class for holding evolution result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 8f1a3ad4ff7..b809fdc9dd3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 3493812c728..4d9064e5152 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.Grover.mdx index 45e9bcdc077..46da55158bd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -168,7 +168,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.mdx index d1c79b38b71..1ba84e863d5 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index d81175b35f6..eef1a0ccb50 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index ae7efaedc91..9d6d58d370a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.mdx index 0b7b18351ec..384ef57ff24 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Imaginary Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.mdx index cf887924848..bb67823bb51 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 16afb56dda0..4f3c73fbb97 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 8b87afe25ef..3b86a20de21 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.mdx index 99513f7f221..4b3cedc7af0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 3350b4dabee..d25fb5e813f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 896d424390d..3bb4d202cf4 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.mdx index 74eb7628985..3ea8bedff17 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Minimum Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.mdx index 3e936e4285f..71bd062bf98 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Deprecated: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.mdx index 3e91f701dc2..c4f820e2ebf 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: NumPy Eigensolver algorithm. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 97f284cce98..390bb60f79d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Numpy Minimum Eigensolver algorithm. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.mdx index 9ea88111009..984ff41a055 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.mdx index 076d6e3f665..cd871f1b3f3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.mdx index 235f32fc817..850b3936843 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.mdx index f71789f22ba..897123ddd03 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.mdx index 82779c0ce8b..bb25d333f6e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.mdx index 3576043a268..3006c3a799b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Deprecated: Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.mdx index 1662908cbee..29de9cb1bd0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Real Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.mdx index 8287b041645..a53d5f0a718 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.mdx index 186a6024755..aacccdb9f54 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.mdx index 44d45d5e4d0..de6604beeca 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.mdx index abd869c5b1f..9b58a133635 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time evolution problem class. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.mdx index e456d345827..8565920c89b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.mdx index 01e1e3db293..99536d8992d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Deprecated: Quantum Real Time Evolution using Trotterization. @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.VQD.mdx index e92326c0402..c08bd720cbe 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: Variational Quantum Deflation algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.mdx index 9c7a9534542..75938c8b4e0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Deprecated: VQD Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.VQE.mdx index b5a5b37bfcd..d18c234bc3e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Variational Quantum Eigensolver algorithm. @@ -239,7 +239,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.mdx index 0bf1832a812..96579fd6d93 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.mdx index 671b7c6144c..8081b58057d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 084e3e3df51..a9484d30403 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 81e23577440..eec147e995f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index ae879b77f80..bf61d01234f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index 32561d698c4..8b53aad5816 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.mdx index 0cca2fd2f35..9dcc3e6ef27 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.mdx index 28e7494562f..c5b9804e8da 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index ec4594c15ec..d1afa7977c1 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.mdx index 7241225fedc..78f351c6d21 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index c97da25344f..b06bcc77a62 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index 0ec1989fd1d..661db43cacd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index e137634620f..383a426598a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 6813567c7f3..88b04a2e841 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index 1457a14aa4a..f307ba7656d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.mdx index 35b6114b0ef..4e85d0f5fec 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index 228d9496fcf..4a5ce47db37 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index db31d950ec5..67192dcad20 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index 89b3c8af6c9..649499bc9fd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.mdx index 281e4b0f240..602e398cb9e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.mdx index bef9c2a273a..b54a92d4332 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QFI. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.mdx index 5bef6162cc8..f3fe59155da 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QGT. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index 24f752d4da8..40f526d26c5 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.mdx index fcf9659b5cf..9d0282252e0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index d37439928a6..100620fff41 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 8a253b786bd..f157ceb1115 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.mdx index fdd8fb38bf1..894a27d2a6d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of SamplerGradient. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index 4feadb223b0..2f538a98f8c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The Adaptive Variational Quantum Eigensolver algorithm. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index b29a8826571..6db0fe43704 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index 506b5ed787f..aad1353103a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index 815ff8ba662..cc8cdc1e4e1 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 19945c23989..b3aaca01fa0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index 23035167419..49eb69714db 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 547614cee4a..958539e14e8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index 9aa89549ec9..54e12471400 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 68db8e1196e..27f3307ad8d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index fe7111c8c67..deb0bc256e9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -145,7 +145,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index a4ddcb35ac2..248f21ab0ad 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") VQE Result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index aa261c76325..650a48ea1e7 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The variational quantum eigensolver (VQE) algorithm. @@ -149,7 +149,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 02fa68a944b..1aaceb24bfb 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.mdx index d362b82d1b5..f1fb4c91531 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.mdx index 1103a0f5a5a..3f2453a1da0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -139,7 +139,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -205,7 +205,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.mdx index 3d9cd51c774..a1d60f74a55 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.mdx index 6921531c995..f7e25f50667 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.mdx index 812884c5dad..74a35d6921e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.mdx index 7d52395b8cc..e16bedd3263 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.mdx index bb5a9ce27ba..5da054b853a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.mdx index 87188365011..8be06247ce0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 3a0a205ea98..851d8bfc8b8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.mdx index 6ab1e7daec7..952f795891b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `NLoptOptimizer` ESCH evolutionary optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.mdx index 753de619433..9fd3c89d0c1 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.mdx index 2a5a3927b04..8505bb1fc21 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -312,7 +312,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -416,7 +416,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.mdx index 70ef88c707c..ab9e5ebf065 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.mdx index 1d66da3b767..f709d936045 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.mdx index 31bb81cf3ad..4e32d567ae9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 5e1ec6e7ef5..5993548d5f4 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.mdx index 13d2ffb3f86..58eeb33b803 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index ddacaaa9ce2..da448ad4c02 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx index 2369428e267..ed40fe7977e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -196,7 +196,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.mdx index c512500b9b9..21a5934aa65 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for optimization algorithm. @@ -113,13 +113,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.mdx index e171b2892c3..ae0334156ce 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.mdx index 12215fbad34..10d5c3e5bd7 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index 8d084d888f3..1831c343b4f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.mdx index 78859fa9857..d3ceb26d3dd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.mdx index 1558721a0c3..4e9d78ab487 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.mdx index 0d89c31afd8..94d71b0340a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -221,7 +221,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -231,7 +231,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -278,7 +278,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -372,7 +372,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.mdx index c19057ef5a3..885116672ef 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -124,7 +124,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.mdx index 9dfaebdc4c8..c7974c8a5b0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.mdx index b1522d59c53..44390f73c22 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -213,7 +213,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -247,7 +247,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -263,7 +263,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -357,7 +357,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 60776891e74..4949cbe2f4f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 3719ccfcfa3..b5f1ce4d926 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -202,7 +202,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -218,7 +218,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](#qiskit.algorithms.optimizers.SteppableOptimizer.step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](#qiskit.algorithms.optimizers.SteppableOptimizer.ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](#qiskit.algorithms.optimizers.SteppableOptimizer.tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -238,13 +238,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -312,7 +312,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -346,7 +346,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.mdx index e54f3840e68..433629df391 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.mdx index 0fe3e151255..f4bb3d212f3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.mdx index 0e2cab946a3..3dd41a87ae8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index 2b91cd0521a..284cf56d3ac 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index df3e1197fcb..32a743b868d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 666e9cdcade..17795b92280 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index e3151ab3670..78dcbb657ca 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index 45a3645ab85..09f37d2a478 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 97df7d44fe1..0cef43fdd4c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index cd427ad8d2b..a859b39534e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 7b93994a106..22593d353b1 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 184f41493b7..ccda62b3a53 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index 5ff32fc85db..ec75b9ea6ec 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 152e0f64b86..670d108cdff 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.mdx index 24de445473a..17e8f4b2d5a 100644 --- a/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") Class for Run Configuration. @@ -67,7 +67,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.mdx index 1e13e4b7407..096ea59defe 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.mdx index 216939cceb1..173f7ce1957 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Bit.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Bit.mdx index cd77d2caa50..6a699692788 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Bit.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Bit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Bit # Bit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic bit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.mdx index c2ec21be149..eefcf5b3d5f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.mdx index efb040e3859..b693121b8d3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.mdx index 2dff91dd3dc..b35d43394a4 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Clbit.mdx index af9c9e2f980..eb30442bf8b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a classical bit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.mdx index 545119e2865..3128cf365a1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.mdx index f4254fde46e..adfd0eb55ff 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class to encapsulate all control flow operations. @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.mdx index 63c232d64d8..3db135b6b86 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Delay.mdx index 4fdac1cd5b1..a7840cfaa81 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.mdx index d7b6b80b6ce..39ce0ebe6ed 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.mdx index 9993ae4bfc5..51a0326f523 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Gate.mdx index 503ff6b54ad..51c79c75d22 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.mdx index 747636854c7..89dabd99378 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Instruction.mdx index 7e1f17ba1cb..d4a14cf027e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.mdx index a3950f32ae9..4e7e9a4bb36 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Operation.mdx index b9bf2f6f69a..954cc1339bf 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Parameter.mdx index 5eca5b3b277..9b975889240 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.mdx index f44e8728603..a5a5ccc628a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.mdx index 8d0fa583df2..8fef5f0bc9a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.mdx index 1c945e410e8..1249ec755e3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Create a new circuit. @@ -478,7 +478,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -584,7 +584,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -594,7 +594,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1390,7 +1390,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1413,7 +1413,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.mdx index bd4e77fd5e6..f90934668cd 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Qubit.mdx index 2486f2aa9f9..23b06156e76 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a quantum bit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Register.mdx b/docs/api/qiskit/0.44/qiskit.circuit.Register.mdx index 926c20210f4..fe2310ade6e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Register.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.Register.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Register # Register - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic register. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.mdx index 53df7e11578..c7bb27efd7b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp # SwitchCaseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") can be used to represent a default condition. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.mdx index 279cfb36cbd..055d45d7634 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 9fcb35beb03..3ad7f9b43f1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `ClassicalElement` The Boolean Expression gate. @@ -202,7 +202,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index de083b5a0e9..7982d9da4bc 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `ClassicalElement` Represent a classical function and its logic network. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index e41726253b9..bfb84f82d1f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index a2df012d72c..4936b83b338 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.AND.mdx index 07d6cdad5c8..dc7ccff310b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.mdx index c65d0f5b42e..11e349f93df 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.mdx index 1476cbec336..1abb8ea46b7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.mdx index 3ab6e9adb5c..8978e3f6120 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.mdx index 0cc1861b89d..c217c16a53a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.mdx index 17c11eaa71e..d82f024e111 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.mdx index 6737542906f..557adcbcd83 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") CCZ gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 098da13ec46..e3b116edd12 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.mdx index fb45738b454..47880219e18 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.mdx index 45432ba9f6d..ba63e0ba582 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.mdx index 0f2ccf563ac..e6f03cbc5aa 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.mdx index 07f4b4be734..95b2a856fae 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.mdx index b1be76ef94f..a28bf6ff9a9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.mdx index 0d5e9018c6c..09a65e0ffd1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.mdx index dc7cd66fd97..5bb2b07a833 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.mdx index 5ebf5355437..fc40cbb1f3c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.mdx index c0a6440c1dd..44817592d7f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.mdx index c232c6cc3f0..ff6a24a2ab8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.mdx index d5bac5475bd..a8c72c68fdb 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.mdx index 72b39c1f683..9f5e5aa6ecd 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.mdx index d1c311acbab..cb0d0c67395 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.mdx index de3f2bf41af..ac8ac9d0cd8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.mdx index cfef6238ab3..7b15953b06e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.mdx index 3c8294ea86d..8f130ce82a0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.mdx index 40d4a07ce97..67e86c62d73 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.mdx index a6f9904c465..6b394eb49f5 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.mdx index 332d6098035..f5bd1cb6de8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.mdx index 373e0077290..1f583828f0c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 0ba273dad9f..adb7c336b35 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.mdx index 8ebb2d6168b..3bd8005d916 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.mdx index 10307d95667..020772c10f2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.mdx index 7b298d6e486..269cafeaff6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.mdx index c6d8bc019a2..be0c144c6d1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.mdx index 06650ffaf87..68d989ab6b0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GR.mdx index adf4c2f4693..ec219c48bf0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.mdx index 9b6268c4e17..b205fccc45c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.mdx index b904b33f753..e190e53f3f7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.mdx index 1603d120947..7ae2007e47a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.mdx index 6203ddaa355..709d0b9bba9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate # GlobalPhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The global phase gate ($e^{i\theta}$). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.mdx index 52e2001960a..c9e1e16a3e9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.mdx index 351ea702e04..d7f6f3aa80c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.mdx index c87b2ac7d2b..7f76362da4d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 94b21a31528..4f9ce476d15 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.mdx index 9ed6f4bf40e..7cd24b77ba9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.mdx index e02bddcda6c..db4c2553db3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Identity gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.mdx index 69631a8c4a2..10eb8b75e81 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.mdx index bad619d7eb3..de260603cec 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.mdx index 1e12ccdfd72..12f77663627 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 9c004942ba8..c68b530f243 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.mdx index 6d3c7d21fe6..81cd8e03a2e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.mdx index a695f788016..6a8dc894301 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.mdx index 3128f732d22..9a718c0427a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.mdx index 714f8e112d5..b1bdd65ed87 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.mdx index 5852b94a4a7..35b3732a0f1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.mdx index 4d3bd9f89d1..93d9f616918 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -145,7 +145,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.mdx index 42d12f4ebf1..d4c6a30ef93 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.mdx index b80f25d6ced..f88d3595655 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -125,7 +125,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.mdx index 4427152a117..8a9004c2104 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -123,7 +123,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.mdx index 01b01b7a427..99aa9afcb39 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.mdx index ea90d5e6dad..2a3d53853ca 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.mdx index 83dd5580a0c..cc77905d6f1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.OR.mdx index 3b6eed19604..ff3fdf4703a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.mdx index 3f1e621d8d2..8efd23513f6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.mdx index a7be7a6f20c..7ca3322d4f2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.mdx index b86f7bafad9..5337b92fe77 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.mdx index 8b40238e207..6cf42b55b4f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.mdx index 958044fff6a..3842dc6025e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.mdx index 0e7e8268c76..55e2a20c474 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.mdx index cd9beb7dbbd..8da832e6cdc 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.mdx index e9ca78e1928..0f6c3f2c246 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.mdx index f7375b8b264..883bc8668d1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -232,7 +232,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.mdx index 8082bcab087..3c433ae1f3b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index d5956640038..ec9db5d6f82 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 15d3c3e4f42..b9fa5f68ae9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.mdx index a6760878d1f..5f45a01cbfc 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.mdx index a3728e78201..f8b59d9270a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.mdx index dba7c894542..b4340ce335c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.mdx index 4a861dfbc1d..0a224f4ae30 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -239,7 +239,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.mdx index 09927059fb8..d44e6192210 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.mdx index ab2db238f0a..0f6d3e98e8f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.mdx index 5abc550ad97..ec3bbedcbb6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.mdx index ae8a2961870..b0368ab628c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.mdx index af07db48c51..163029c8161 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.mdx index 10c2aff976d..8e330fb5147 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.mdx index 846e96c4d73..c8c8caf9504 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.mdx index e6416e554e4..34cf73653b9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.mdx index 0bcded6c849..d9faf0a2a3d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.mdx index 5bb6a06892e..f400b7ddd6e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.mdx index 41ba54804fb..0f32a680f9b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.mdx index 77cb5fcc995..92f34344109 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.mdx index 261b2dd606f..f8691c426be 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.mdx index 2093806b398..44991df9f79 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.mdx index a0c3d846f8e..996ec129254 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.mdx index 5d91167c35d..a982e808142 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.mdx index f7b897dee80..2f40132a4f8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.mdx index ceadb112a94..20f2974d970 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.mdx index dd8aa35985a..1f237e63b10 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.mdx index 377ff815b04..27dfa43181e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.mdx index a205b891212..9fdf0f4d91e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The SWAP gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.mdx index 5f0c85b3e57..4a30b38c55f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.mdx index d3427a0bf5c..2bbb8c66cac 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.mdx index 94cb09336e7..64e3e2de3e4 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.mdx index c4b5b473554..f0ad853d8ac 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.mdx index e115d820c6e..46687c70ceb 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.mdx index 87d9307d846..cc630f84008 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.mdx index af07e514294..f4f2d3a4d1f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.mdx index 52354ba1671..b7e1b786656 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.mdx index 6bce1ba5679..f63ce237130 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.mdx index b60bf9a230d..2ea4b841fc7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.mdx index 2257d7b4699..36f6e6579e0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.mdx index a79bebaf540..ebf5eda4682 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.mdx index 091d7b35077..6fa99b7c4d7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.mdx index 71adb73a0e0..cef20f2509f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.mdx index cf0d9d9c29a..2c503939dd6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.mdx index d1f72b15967..2a8b43b139d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.mdx index 1ebda23aaa4..dde7b0ce676 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.mdx index 8c934804611..09a960f4756 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") iSWAP gate. diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.mdx index 87025d2b68e..284a16f92fa 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser # BlockCollapser - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This class implements various strategies of consolidating blocks of nodes in a DAG (direct acyclic graph). It works both with the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") DAG representations. diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.mdx index 5a176973b9f..113ce9886df 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector # BlockCollector - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This class implements various strategies of dividing a DAG (direct acyclic graph) into blocks of nodes that satisfy certain criteria. It works both with the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") representations of a DAG, where DagDependency takes into account commutativity between nodes. diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.mdx index e768b7cd0b8..ef31026b80d 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.BlockSplitter # BlockSplitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Splits a block of nodes into sub-blocks over disjoint qubits. The implementation is based on the Disjoint Set Union data structure. diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.mdx index 3133ede9886..ba5f8df09f7 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.mdx index 0dbe2c5134e..d8fd84d7585 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent the information at a node in the DAGDependency(). @@ -91,7 +91,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.mdx index 2299a919faa..a6116ba4d94 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.mdx index 5c1dcb65c3a..7b6ad0f6c9f 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://qiskit.org/ecosystem/rustworkx/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.13.2)"). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.mdx index 761253db515..4e744d33bb6 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://qiskit.org/ecosystem/rustworkx/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.13.2)"). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.mdx index 2fb634f15bd..ec89dd97de9 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -43,7 +43,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://qiskit.org/ecosystem/rustworkx/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.13.2)"). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.mdx index ab0eb38ad42..409cb897a6d 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://qiskit.org/ecosystem/rustworkx/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.13.2)"). **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.mdx index 17a847cdff4..4ecdf86f3f9 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.HamiltonianGate # HamiltonianGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hamiltonian operator as a gate. diff --git a/docs/api/qiskit/0.44/qiskit.extensions.Initialize.mdx b/docs/api/qiskit/0.44/qiskit.extensions.Initialize.mdx index 223e7bff422..6ee6302ffd0 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.Initialize.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Initialize # Initialize - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.mdx index d64cdc7b7bc..2ff03662765 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit unitary. diff --git a/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.mdx index 0af947ccf1a..7549cd570f8 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.mdx index aad7b11318a..28115b0e066 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate # UCPauliRotGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.mdx index 51dad809fd1..8ba3d934cea 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRXGate # UCRXGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.mdx index 97f6d117231..cbdf2a14438 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRYGate # UCRYGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.mdx index a59130c9826..55eb1894099 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UCRZGate # UCRZGate - + Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") Uniformly controlled rotations (also called multiplexed rotations). The decomposition is based on ‘Synthesis of Quantum Logic Circuits’ by V. Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)) diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.mdx index 928ecbeac8f..a60e6606468 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.mdx index fba06a6822c..4eb295f5f2a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -63,7 +63,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Returns** @@ -95,7 +95,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -177,7 +177,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -209,7 +209,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -263,7 +263,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -309,7 +309,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -327,7 +327,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Returns** @@ -351,7 +351,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.mdx index 183df6cfed0..7b38ead5a61 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.mdx index 032a9931764..0b376441c23 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.mdx index eee5f6b5514..6f7b85488e7 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.mdx index a341b0791b7..42e3773e3e1 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.mdx index 428c58f9a94..6dfb256f238 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -169,7 +169,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.mdx index c9c86d57045..3c2c8fa05ef 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.mdx index 6f02dab9247..9ae3dbddd67 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.mdx index 2bcc31d3d9b..4728b1374e4 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + 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.44/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.mdx index 5b432a9fd5e..5f665ab58f8 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.mdx index 5ed52c6eb73..eea4d1ab9ea 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 609f6b3f082..50629e7b9aa 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.mdx index 9cd9da1984e..3d12444b42e 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.mdx index f6649d11fe6..e2bb484a1d2 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.mdx index 8d58987986b..04e8fedc03a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Deprecated: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.mdx index 6a69e2ad285..e0bdca6f855 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 67585b74500..58ba0c1f97d 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.mdx index 706c66289fc..34a97cba35e 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.mdx index 1ad0b6456c0..269aa54cb4b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.mdx index 768ff11de1d..5ff5fa9a871 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.mdx index cce94fb7cb7..63b6f7893d1 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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.44/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.mdx index b14044aed6d..ca244d57393 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.mdx index 660ad403773..831060b8aed 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.mdx index b70bbbe06fc..f9c35c4d70f 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to gradient operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.mdx index 880789e8998..4659e11f04f 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to Quantum Fisher Information operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.mdx index f8d0b4e6934..8e0634b67f3 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Base class for differentiating opflow objects. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.mdx index fe9b68663e3..f16e0c07c8b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.mdx index 26911feda31..d01592eb8ad 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.mdx index 88373a7e49f..559cb021b1c 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Deprecated: Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.mdx index fc255872a3d..bc28445298f 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.mdx index 6efc0821d33..5bdb1f34fd6 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. @@ -89,7 +89,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.mdx index 0e360762438..9f38ac9755b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Deprecated: Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.mdx index 6333f6a2888..70b0cd88bec 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.mdx index 14f1cf9cdfd..058574ade59 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.mdx index 197d2b8cc1b..f4c9e349ecc 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.mdx index 000671e23fc..28e15c9ad0e 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.mdx index 8d59b07129f..0a93811a40b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.mdx index a108230c958..d4df40c45dc 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.mdx index 5dbe55d12ff..6867c1be95a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.mdx index 3f2662864b6..edd0d8684d8 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.mdx index 07ad11bf011..717f42b2cc2 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -199,7 +199,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index c22d9adb9ac..b892cc1219d 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index a244657fe68..de1d6753cbd 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Deprecated: Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index c376bbe0044..d9a6843fa5a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Z2 Symmetries @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.mdx index 212177f23a5..c92f33b2c65 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **Deprecated: A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.mdx index d6a59c20dd5..bdbfa768a68 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.mdx index 8d5c3356ad7..b39d3da7363 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.mdx index eb6bfea8b00..9b5b0d6a362 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index fbcd7c4afb1..38eb8fa8085 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.mdx index 2ca97100fb0..ea2479c2aaa 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.mdx index d81b7c4746e..b0b0c21f5e6 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.mdx index 37b1aacfa96..3e4abe46f34 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.mdx index 6d9f6df010b..08f288dfdc1 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.mdx index 87fd8462c2c..5bc1a4374f8 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Estimator base class. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.mdx index 59ce6313535..aaf33082aef 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Sampler base class diff --git a/docs/api/qiskit/0.44/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.44/qiskit.primitives.Estimator.mdx index 936233963d3..02d88278d76 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.mdx index a5c83abe9c4..c7f54ca0d4d 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.44/qiskit.primitives.Sampler.mdx index 341880be272..2d4404f5052 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] Sampler class. diff --git a/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.mdx index e0e4496bdde..aabf3ac8a89 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.44/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.44/qiskit.providers.Backend.mdx index 406d2dd245b..ba0b3944c7f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.44/qiskit.providers.BackendV1.mdx index 56393147f81..a9f09944ace 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.BackendV1 In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -121,7 +121,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.BackendV2.mdx index 163c55d70f8..dc28e615130 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -292,7 +292,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.mdx index 6952bebb742..f9aeed639d9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.44/qiskit.providers.Job.mdx b/docs/api/qiskit/0.44/qiskit.providers.Job.mdx index e65efaf75b1..cfc9355a0fe 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.44/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.44/qiskit.providers.JobStatus.mdx index d40736a0e16..2a09fd491f2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.44/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.44/qiskit.providers.JobV1.mdx index 067d5ba297a..5d3c53b8d0a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class to handle jobs @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -105,13 +105,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.44/qiskit.providers.Options.mdx b/docs/api/qiskit/0.44/qiskit.providers.Options.mdx index 136620d0e8b..0ed5b17b60f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") Base options object diff --git a/docs/api/qiskit/0.44/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.44/qiskit.providers.Provider.mdx index 079653019c9..e8b9daa2536 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.mdx index 151f4a64b41..27fc4178e74 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a Backend Provider. @@ -23,7 +23,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.mdx index 54cab1c617b..5dd69af5a78 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.mdx index c592f2d6bd5..d93982b1fc7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.mdx index 8f48423247c..77b8e803290 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.mdx index 6542dcd995e..862fba1ab24 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 597a911e1f5..1bb1a897997 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of an OpenQASM 2 simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 26a7c660307..d973daa3868 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index a346df7675c..63571376671 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 67380ccc985..e9ff6cbcee8 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: `FakeBackend` Configurable backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.mdx index 2ff52ab654d..110f68e34e7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: `FakeBackend` A fake 1Q backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.mdx index acc81f77822..3f529039db0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: `FakeQasmBackend` A fake Almaden backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index b3e06f7fcfe..594f8a56d75 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: `FakeBackendV2` A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.mdx index 30e48e80e5a..210e27d8aea 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: `FakePulseBackend` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.mdx index da2139b6322..9c4fd4c026f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: `FakeBackendV2` A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.mdx index e94880eb56f..86e918fe316 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.mdx index 68207def785..9c558ca4e87 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.mdx index 2e3ed50cd23..e89c97cc58b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index 9eb3adbc664..2c52f68a09a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.mdx index d656302bcda..18b8db29b65 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.mdx index 0c91f7ae130..f78d2cd1a2d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.mdx index 845fc55f152..397a3d7f1ab 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.mdx index 45e0f710cb6..7c1c766e014 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: `FakePulseBackend` A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index c76f5082e87..0bf49cce8e3 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: `FakeBackendV2` A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.mdx index faf61ac7107..0f7712b61b5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.mdx index b228c18f7dc..6d35b861367 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.mdx index b0f157a2ee2..572af747cbc 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: `FakePulseBackend` A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index a72eccb3290..d31fac61135 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: `FakeBackendV2` A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.mdx index 0e8ea3816a9..84c33ceb947 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 49fc739ef88..6c1d5ad45e6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.mdx index 3b23ce16564..76da08120e6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.mdx index 139f9f7ded1..395ae5a42be 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.mdx index c332cad415d..77933245e81 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: `FakeQasmBackend` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index f577e3a79df..3cf3ad2a05a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: `FakeBackendV2` A fake Cambridge backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.mdx index 4559ac2bc25..fa5372eba8a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index 84d7442086d..f4d07e18b63 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.mdx index 70efe729f2a..45e8b1ca56b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.mdx index 4a9d1c8a043..7a2cf7375c2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.mdx index e0232523534..9e934f975c2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.mdx index c110424ed75..c313d734743 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: `FakePulseBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index d3704644802..59db54d4e44 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: `FakeBackendV2` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.mdx index 76a22d239e3..8a0a5c40577 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.mdx index a00b599af4a..9264f8c1a01 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.mdx index be18de461c1..3bd7b9ee2f4 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 9eb21a757f1..6e1689011e9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: `FakeBackendV2` A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.mdx index a8a9f1b5683..934d26421cb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: `FakeQasmBackend` A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 106c2416da4..f9b1afc23a2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: `FakeBackendV2` A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.mdx index e073e1d9e90..7120169abeb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 05b9d472965..9bfcd99f530 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.mdx index a3965a48ce1..147189a92f0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.mdx index fe233b05a6f..22025084fa1 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.mdx index 7f60388b13b..59c15c3124e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.mdx index 43096fc5285..3a6c906225f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.mdx index c16a4515903..02e46249144 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.mdx index 0ec600ba0db..b9a4a486707 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.mdx index 5684255139c..25ad27969f6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: `FakePulseBackend` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.mdx index b94c0421df0..9e889e4214e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: `FakeBackendV2` A fake Manhattan backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.mdx index acb9078a13c..dbb559b853e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.mdx index 1c7f90f79e3..20f0983317c 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.mdx index a82e91799c3..c15fdb85699 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: `FakeBackend` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index a46a4087a67..5c46e476247 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: `FakeBackendV2` A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.mdx index 1c1cb3132eb..a1aba1d9cfb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 28aa18a63dc..309ffcc00ee 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.mdx index 73006a50a38..47db04cf6d9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 4d0b5d891e6..a828377ecf3 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 30b21f825dc..f46d3feaa2a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.mdx index e1c7c9b5c79..31610fadef7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: `FakePulseBackend` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.mdx index d8b333ca0d0..1086479559b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 62b8c492e9d..f53665f847a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: `FakeBackend` A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 6756acd9e9a..fdcc6276f4e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: `FakeBackend` Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.mdx index d7526936fa5..099cdfb8c32 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.mdx index 89421ae6642..65f56b53e6d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.mdx index 8431e39c58d..77e72c3dffa 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.mdx index 97543cfac5b..12e38ecff26 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: `FakePulseBackend` A fake Paris backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.mdx index 4420e0ea3f9..b64780156aa 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: `FakeBackendV2` A fake Paris backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.mdx index fd41c47adb2..1edba1b1c20 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: `FakeBackendV2` A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index 7399928dfa0..63cbb5e619d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: `FakeBackend` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index fd854a929f0..a852bad283f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: `FakeBackendV2` A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.mdx index 7036c99eb57..fea7c066aa5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: `FakeBackendV2` A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.mdx index 578ead4964e..f62db78c583 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index d3679c18776..7e88745f2f0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index 9c368b47412..d1e4450e62f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: `FakeBackend` A fake simulator backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.mdx index b3e36d82a12..4593efe2e71 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 0e5b36ba42c..a614a715c95 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.mdx index 144cac9eedb..ec57430c0cc 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: `FakeQasmBackend` A fake Rochester backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 581ddba0ee0..ca43ee61fb5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: `FakeBackendV2` A fake Rochester backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.mdx index b8d04b421e3..463f0c9ba99 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.mdx index 123d7fd9f91..173a8db6a83 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 9dcfbaa9164..91fdf22b4a0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: `FakeBackend` A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.mdx index b0ee55f54db..b162835ee44 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: `FakePulseBackend` A fake Santiago backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index bc7fc232117..ed248849aef 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: `FakeBackendV2` A fake Santiago backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.mdx index d801e7df85a..2e55e1795d4 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: `FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.mdx index ff2bbf78392..69f464eab6d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: `FakeQasmBackend` A fake Singapore backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index cefa033f0f6..9e3e8201520 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: `FakeBackendV2` A fake Singapore backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.mdx index 1dac2777713..1970b13da5a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.mdx index 401b9e33777..d55a6d6b867 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.mdx index 6f5fba025e2..b5832bdba08 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: `FakeBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.mdx index 61c735bd5c3..b33ccb2a324 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: `FakeBackend` A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.mdx index dae97cac52f..23c6ec56c6d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: `FakePulseBackend` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.mdx index d5a40f36fbf..9307e87ae75 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: `FakeBackendV2` A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.mdx index a26db2af91b..0037766ea10 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: `FakePulseBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.mdx index b09392405ab..6178c37ef9a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.mdx index a5efdc2bdb5..a12c7db4f9e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.mdx index 6717eb1e6de..38b1a2fe08d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.mdx index 5191304fd8c..d8767bb67f6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: `FakePulseBackend` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index c41736e11f9..a28c3bddaa9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: `FakeBackendV2` A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.mdx index ffa08f835a3..ec1e46b109d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: `FakeQasmBackend` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.mdx index 83da748e497..30fd5000f25 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: `FakeBackendV2` A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.mdx index 397015d3c6c..bbc36267b42 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -99,7 +99,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.mdx index 29d5580af9d..4c0b8e61d50 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.mdx index e566c9e0056..f3122ed9435 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.Command.mdx index 2a3edaa330a..0445c562322 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.mdx index 7afbef04a31..ce246e42753 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.mdx index 277e8fb764c..c93dd18d1c2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.mdx index 7885eb15e59..701d78f2274 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -182,7 +182,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.mdx index e5e331fa587..36e447c2330 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.mdx index 400eca41c5c..49b498758c6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing an OpenQASM 2.0 Backend Configuration. @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.mdx index f24d77091ec..8799aad7037 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.mdx index c7b9cafd2d9..596e5afe3bb 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") 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: diff --git a/docs/api/qiskit/0.44/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.44/qiskit.pulse.Schedule.mdx index 75a345cce70..0e1c095d734 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -338,7 +338,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.mdx index deda42b5c50..c8c541ff5a0 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time-ordered sequence of instructions with alignment context. @@ -480,7 +480,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.mdx index 554c7f54b70..886fede9ad9 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.mdx index bf212113b56..948baf9a0d7 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.mdx index 0acc4148026..5e09c23d51b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.mdx index 0084952e53c..cbdb632a7c3 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.mdx index da6c78be7e6..5b870e4c90c 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.mdx index 224a08700e2..a84df3ec704 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.mdx index 31644ba0924..f96fadf7bc7 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.mdx index 41bc1691a65..98fc322591f 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.mdx index 42a5d1d1da7..a831df3cd54 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.mdx index cc08de960c5..787232047a2 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.mdx index d0ce1e3c048..02205f22ae5 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.mdx index 14550e5868d..16b51734925 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.mdx index edffe70dded..2087299856b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.mdx index 94c8e57a8a6..a19030bd007 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.mdx index a66c5b832cf..9d3001e3d78 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.mdx index 7186802dd02..037ec71515b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.mdx index f53db5a82e8..09d3645e4e1 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.mdx index 6c9765dc570..8486176db2b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.mdx index d40de7a263b..362a3b5516d 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.mdx index b77acf9ffa2..507488b8ac5 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.mdx index 4a9ffcf9302..2032658e4db 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.mdx index 606f769cc6a..c3980a2c411 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.mdx index 8ee9a4d03cd..fe6d96f9a4d 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.mdx index 79b636d530b..80fa84f8871 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `Pulse` The abstract superclass for parametric pulses. @@ -95,7 +95,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.mdx index 2052e29caba..fc6fc91f357 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse # ScalableSymbolicPulse - + Bases: [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") Subclass of [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse") for pulses with scalable envelope. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.mdx index 749d1c39daf..fbbd60453c0 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.mdx index ca0012ecd55..3e388f8fdae 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.mdx index 6aff7d09b41..59e82f0277a 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.mdx index c54946fd213..ef9d6b907c6 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.mdx index 680e5bbee18..1039bd2bb93 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.mdx index 97a76c55e45..9cadc1c4782 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.mdx index 4b42c5e9dcf..c1c2e51687f 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.mdx index 663d4644f0a..609eb4b0fe4 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.mdx index f1c76eea206..cd0e219c0ba 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.mdx index 2b06041edda..5b7dcb6765c 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.mdx index 1f0bc5eb4ca..d7e4d29b3b6 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `QobjDictField` A configuration for a Pulse Qobj. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.mdx index 8695a4fb620..a16613df75d 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.mdx index 568cc7b21ca..d104035a8b4 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.mdx index 6e3dae88a16..19e70503441 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.mdx index f20f054619f..bd008ac44fd 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.mdx index 874fab97b95..99db0f8ab53 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.mdx index b99ccb3892d..63a82692208 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") A configuration for an OpenQASM 2 Qobj. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.mdx index a7e443362bd..c9bd8ddba16 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.mdx index d483b65e6b8..148107106d1 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `QobjDictField` Configuration for a single OpenQASM 2 experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.mdx index 6f80d1da8a3..643d81abd10 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.Qobj.mdx b/docs/api/qiskit/0.44/qiskit.qobj.Qobj.mdx index 33663a2f269..2cad5978889 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.Qobj.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.Qobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.Qobj # Qobj - + Bases: [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") A backwards compat alias for QasmQobj. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.Qobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.mdx index 77fe936b11b..fbdaf931b67 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.mdx index 844eb168581..1c629d1189e 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.mdx index c59109f5575..8393e90c0fe 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.mdx index 423355b47a8..4b3e545d28a 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.mdx index 43f8042749f..d0ad75f4b3f 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.mdx index 10662a1324b..5ec30fb1d62 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.mdx index 0d5c6628cb2..39a52e8902c 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -295,7 +295,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -317,13 +317,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -371,7 +371,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -395,7 +395,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.mdx index a471bd19481..1952f1af0e3 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -184,7 +184,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -208,7 +208,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.mdx index b2e3089fabd..87f106cc43e 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index 9d588dccab9..5bbf3111031 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.mdx index 16ed2e102cc..59ceb5c6f46 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -223,7 +223,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -248,7 +248,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.mdx index 14f8729272e..7ba283cc99b 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.mdx index 5649c4e3d31..6925763ccd3 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -452,7 +452,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.mdx index f6de5eae0c9..1a47762de43 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -424,7 +424,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.mdx index 467c7b4115f..c8c23256399 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliTable # PauliTable - + Bases: `BaseOperator`, `AdjointMixin` DEPRECATED: Symplectic representation of a list Pauli matrices. @@ -392,7 +392,7 @@ $$ ### from\_labels - + Construct a PauliTable from a list of Pauli strings. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.mdx index b0e099d8715..3954598700f 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.mdx index f5c8b7b9362..0a30ab419f6 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.mdx index 94a1500422b..bc67b43cdc6 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -346,7 +346,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -382,7 +382,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -408,7 +408,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -689,7 +689,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.mdx index 3f573bc47b8..55ab7b22e36 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.mdx index 6c0499c64a7..021ed9d5a40 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable # StabilizerTable - + Bases: [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `AdjointMixin` DEPRECATED: Symplectic representation of a list Stabilizer matrices. @@ -437,7 +437,7 @@ $$ ### from\_labels - + Construct a StabilizerTable from a list of Pauli stabilizer strings. Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.mdx index 3ef33aec507..d776cf9be4d 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.mdx index 6368c147f8c..09d308b68d3 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.mdx index 91e0994b24a..f07da52b87b 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 092bb211f78..e8d78c2467b 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.mdx index 190fce5421d..aaa1858fe5c 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.mdx index bb9b74f0e9b..1ea55c39e6e 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -111,7 +111,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries ### find\_z2\_symmetries - + Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). **Returns** diff --git a/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.mdx index cced9da8946..e88c4ed9fe1 100644 --- a/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.mdx index 5f7ed4928ff..dee13545068 100644 --- a/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.44/qiskit.result.Counts.mdx b/docs/api/qiskit/0.44/qiskit.result.Counts.mdx index 6e9a4e1491a..31ecf7f1e59 100644 --- a/docs/api/qiskit/0.44/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.mdx index a3b41a7fab1..178c52eda0d 100644 --- a/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.mdx index 68d38af7c4b..998e82bdbc9 100644 --- a/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.mdx index ceaee072dd0..dd531932171 100644 --- a/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.44/qiskit.result.Result.mdx b/docs/api/qiskit/0.44/qiskit.result.Result.mdx index b7386de0968..fa0cea58bd8 100644 --- a/docs/api/qiskit/0.44/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.44/qiskit.result.ResultError.mdx index 8580c2fc5ab..15dbd089298 100644 --- a/docs/api/qiskit/0.44/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.44/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.mdx index 56ecd4faa86..fb13a5da869 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for evolution synthesis algorithms. @@ -33,7 +33,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.mdx index 0e487b33b19..570b5e011df 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.mdx index b874ac2c56e..d678b2d8b62 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.mdx index 64becc6af0b..1c0423965be 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -43,7 +43,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.mdx index cb411361e3c..41644a81b27 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.mdx index 5574968081b..eb895175df7 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.mdx index 34180a1d2aa..059f2e9b202 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.mdx index 5fc2d2b623c..85369a05ad4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `BasePass` An analysis pass: change property set, not DAG. @@ -41,7 +41,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.mdx index c5357ded008..2ddd68b044e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.ConditionalController # ConditionalController - + Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes under a certain condition. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.ConditionalController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.mdx index 2919dcb07fc..56a5d878569 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Directed graph specifying fixed coupling. @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -224,7 +224,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -247,7 +247,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.mdx index 9a7cde79436..c204334bebc 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.DoWhileController # DoWhileController - + Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") Implements a set of passes in a do-while loop. @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -34,7 +34,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.DoWhileController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.mdx index 22b0a16e374..c45e7001df9 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.mdx index 4a59fea3201..47d3159a17a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.mdx index 70d7658dbf6..8eada669ad7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FlowController # FlowController - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base class for multiple types of working list. @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.FlowController ### add\_flow\_controller - + Adds a flow controller. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.transpiler.FlowController ### controller\_factory - + Constructs a flow controller based on the partially evaluated controller arguments. **Parameters** @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.FlowController ### remove\_flow\_controller - + Removes a flow controller. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.mdx index 08bcf9eafee..9897b178403 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.mdx index 9fced76a89c..d9286d59ca4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.Layout.mdx index e7232fa0704..e03c3d370eb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.mdx index 83ae154916e..1908b18c9f4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.mdx index a03ac96ca63..6b0618296b0 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.mdx index 2832dc171a1..2b75e39156d 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PropertySet # PropertySet - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A default dictionary-like object diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.mdx index daf7cc4cf8b..39b15fa2de6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A Pass manager pipeline built up of individual stages diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.Target.mdx index 17eae9d7fd0..561894bc90d 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -255,7 +255,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.mdx index 95aeb1ad58e..343936ba36c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `BasePass` A transformation pass: change DAG, not property set. @@ -41,7 +41,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.mdx index b0621a1458c..e1736e9e541 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Layout attributes from output circuit from transpiler. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.mdx index 3a9af047ee6..b5caa16b45b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index fe6de9bd421..755ae813499 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.mdx index b6a3b033f67..46568f75452 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 8760099e0e8..5718b8e0128 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.mdx index 6a45e6d7840..7471fe6538a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.mdx index c230b518336..f9adf2769a5 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.mdx index e8513be934a..b1edb7601f5 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping # BIPMapping - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 32e392cb85a..1aaca9e5b40 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.mdx index a3096ac0226..73fbb5feb41 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.mdx index 7acf5b540b1..1433797eea7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.mdx index bbd0620270e..d6cfe9d2b31 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.mdx index 99fe735690c..2971983712f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.mdx index fc2c483f724..eb1cf3bab47 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection # CXDirection - + Bases: [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.mdx index 2fb30409135..e10d82ce5af 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection # CheckCXDirection - + Bases: [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.mdx index 337e2f8f19e..05bacfd1d8e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.mdx index e380907176a..fcab5706d51 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.mdx index 2111413d539..12a33e8b3d6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.mdx index 86279cd7d27..fd33f2988d1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.mdx index e7301a418f1..56550fbf5ee 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 9ca6b856962..3d573f9453a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `CollectAndCollapse` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 0c61aad913d..bb34b622728 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.mdx index a86af21e307..47e3619e8d0 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.mdx index 7ed1c614c19..c25a82c9350 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index 9a154a37ddc..14a9e6f5600 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 8b58606a04f..f949f4eb327 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 5e832b2805c..a34c89ae3ec 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 622fa22138b..cb823d2dfac 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.mdx index 32130da48fb..6b44643b121 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index ed11831442e..1da15f74449 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.mdx index c47b2df77f5..e29ecccc651 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 68df9bf17d5..6f47b25e9a0 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index a25c5ddd55d..a012d887f67 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.mdx index 80e40aff9a5..5200bbdb591 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.mdx index aa8c49e535e..fd781b33e1f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.mdx index 7ff272cdbbd..ab4a915444b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.mdx index a51caf55339..5913c085441 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.mdx index e0a089463e0..ef4d523f8c5 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 223c76a22de..81230a6edf2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index d884c9d3312..41522966f16 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index f282ef277ed..a510fae7810 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.mdx index 0115eec3e4b..8b086f98885 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 3a355d44b78..862b58e56d3 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map or target as ancilla on the layout. @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.mdx index 0101511a384..4a7e03f85f2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.mdx index 796e911507c..58e28263aad 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.mdx index ab6af32395c..49de6970b7f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects using synthesis plugins. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.mdx index ed2aaa28aa7..373f0989ea7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.mdx index e96103e614d..fea9b20bd52 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.mdx index c895137cdcd..9343bb0b88c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.mdx index f595afbc52b..6cc20c11cbe 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 367a651f044..040bcc07727 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index fcab7c45150..c07199602e7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.mdx index 0b9e0b700b6..510425f79aa 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index becf38a556b..971f780c4f8 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.mdx index 21f79a1db9b..1c27e90dabb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint # MinimumPoint - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Check if the DAG has reached a relative semi-stable point over previous runs diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 6c183efbf36..98c277bdeba 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.mdx index 8e45e8c8191..d5609a35955 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.mdx index 1b5a21d6f56..20b92435423 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -43,7 +43,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -83,7 +83,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 65f98fb594a..32cd3d4abca 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 6c07dfefdb0..ee71af57b00 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.mdx index 14a969bc99a..57de8695705 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.mdx index 8a1763a95f1..a30df2ff3ad 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 11ef2629ac9..007351766fa 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.mdx index 5658c7c9c9e..46f35a089a0 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 0ab98ef64a6..e9d2c58d438 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -83,7 +83,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 17214086ee1..563a828cd82 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.mdx index b7b3592a0a9..cf587e38390 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 918a3d71000..373dd5a6241 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 6ce6de0222b..b4174d7d1e8 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index d907004b3fe..baa64662e03 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index f45c298eea1..f6b70bcb1dd 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.mdx index 1b896270372..71ee7c34efb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.mdx index 5da5d2b5ebb..f758d7f2515 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.mdx index 8917f3dc849..0a2a1a5a39e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.mdx index 7ee1ad8dcd1..cccd2a803d1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.mdx index 65c832ad30b..3bd3c6b239f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.mdx index e2980dedb72..a4c51a58897 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index bf20a3f0a1c..0db0fbe3815 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.mdx index 1acdae5f48a..60a9dd304b7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.mdx index 479f66772a6..4b2a643e2f1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.mdx index baad35ddce1..9611fe6f25f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 06a3a7e76eb..0aab73acc20 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.mdx index dd161c323c1..3bccd96099b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.mdx index 78b148960dc..0ed689ce251 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 2c9b64700ce..eedd1d6d515 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index ce2da9e816b..916218ea3bb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.mdx index 209ddb385db..ce1ba691256 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops # UnrollForLoops - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.mdx index 9512324bf0e..58d34f7863c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.mdx index 69f8a30059c..e3ced6f3ab6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.mdx index 2cc705787a9..c0f31f5618e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.mdx index 0591eb47c75..8aec8e37631 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.mdx index 6651a5bf14f..5c76870832f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index 2afa6a0576e..f752771fa85 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 5c1603b346e..29e3de369f9 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 69377b45123..71ea030e325 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract unitary synthesis plugin class @@ -176,7 +176,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index d936cd55f8d..69cf7565c95 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 8e406be3d84..0d9fa7ef3bb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 9483615d61d..da067cdb292 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.mdx index c212ac200ce..24ebb3be7ae 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A generic implementation of Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 6f3a2d7a85f..aafb7b30536 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 044ca2be8bd..945203754d8 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class that represents an approximate circuit. @@ -215,7 +215,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + **Constructs this circuit out of the parameters(thetas). Parameter values must be set before** constructing the circuit. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 09520eb0a62..4ce7df0f1d4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index ca74620bab1..55972a7b31a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index b2c9774eb51..f5e17a60f66 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index fb86ce89b8b..23347c66557 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index f07e621a606..fbba9caa44b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.mdx index 8a1bd0f2a70..deeaf2ea69c 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.mdx index eb2e3a4ca11..30f19531526 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 4fa8f720458..da1ff3c5fe0 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.mdx index 568d72752f3..4e3f2e0edd1 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.mdx index 2793486d82d..2a2803d78a9 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.mdx index 79a5aa076b3..8e8fd865876 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.mdx index 7fcabaad25a..d1b930e08cb 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.44/qpy.mdx b/docs/api/qiskit/0.44/qpy.mdx index 8c9efab18d4..354d7d89b72 100644 --- a/docs/api/qiskit/0.44/qpy.mdx +++ b/docs/api/qiskit/0.44/qpy.mdx @@ -157,7 +157,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski #### QpyError - + Errors raised by the qpy module. Set the error message. diff --git a/docs/api/qiskit/0.44/scheduler.mdx b/docs/api/qiskit/0.44/scheduler.mdx index 67cce56182a..0a09c5a5c8a 100644 --- a/docs/api/qiskit/0.44/scheduler.mdx +++ b/docs/api/qiskit/0.44/scheduler.mdx @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.44/tools.mdx b/docs/api/qiskit/0.44/tools.mdx index cc3bc4125c0..e50797d4959 100644 --- a/docs/api/qiskit/0.44/tools.mdx +++ b/docs/api/qiskit/0.44/tools.mdx @@ -151,7 +151,7 @@ A helper component for publishing and subscribing to events. #### TextProgressBar - + A simple text-based progress bar. **output\_handlerthe handler the progress bar should be written to, default** diff --git a/docs/api/qiskit/0.44/transpiler.mdx b/docs/api/qiskit/0.44/transpiler.mdx index 537af658de7..d37a65cf7e0 100644 --- a/docs/api/qiskit/0.44/transpiler.mdx +++ b/docs/api/qiskit/0.44/transpiler.mdx @@ -936,7 +936,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError - + Exceptions raised during transpilation. Set the error message. @@ -944,7 +944,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -952,7 +952,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError - + Base class for errors raised by the coupling graph object. Set the error message. @@ -960,7 +960,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError - + Errors raised by the layout object. Set the error message. diff --git a/docs/api/qiskit/0.44/utils.mdx b/docs/api/qiskit/0.44/utils.mdx index a3ed3a9e305..e9ae8ff6b1e 100644 --- a/docs/api/qiskit/0.44/utils.mdx +++ b/docs/api/qiskit/0.44/utils.mdx @@ -450,7 +450,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -490,7 +490,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -557,7 +557,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -571,7 +571,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.44/visualization.mdx b/docs/api/qiskit/0.44/visualization.mdx index fc10d8401c8..12813b8702b 100644 --- a/docs/api/qiskit/0.44/visualization.mdx +++ b/docs/api/qiskit/0.44/visualization.mdx @@ -235,7 +235,7 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.45/algorithms.mdx b/docs/api/qiskit/0.45/algorithms.mdx index 53efd605364..377c95f32fd 100644 --- a/docs/api/qiskit/0.45/algorithms.mdx +++ b/docs/api/qiskit/0.45/algorithms.mdx @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states. #### AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.45/circuit.mdx b/docs/api/qiskit/0.45/circuit.mdx index 425d866ed94..06dbb8b332c 100644 --- a/docs/api/qiskit/0.45/circuit.mdx +++ b/docs/api/qiskit/0.45/circuit.mdx @@ -344,7 +344,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c #### CircuitError - + Base class for errors raised while processing a circuit. Set the error message. diff --git a/docs/api/qiskit/0.45/circuit_classical.mdx b/docs/api/qiskit/0.45/circuit_classical.mdx index 94dd4fba451..52801fa8446 100644 --- a/docs/api/qiskit/0.45/circuit_classical.mdx +++ b/docs/api/qiskit/0.45/circuit_classical.mdx @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr - + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap #### Var - + A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` #### Value - + A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary - + A unary expression. **Parameters** @@ -91,7 +91,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -114,7 +114,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary - + A binary expression. **Parameters** @@ -126,7 +126,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -209,7 +209,7 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast - + A cast from one type to another, implied by the use of an expression in a different context. @@ -590,7 +590,7 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor - + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. ##### visit\_binary @@ -735,7 +735,7 @@ All types inherit from an abstract base class: ### Type - + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -747,13 +747,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q ### Bool - + The Boolean type. This has exactly two values: `True` and `False`. ### Uint - + An unsigned integer of fixed bit width. @@ -796,7 +796,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. ### Ordering - + Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. diff --git a/docs/api/qiskit/0.45/circuit_singleton.mdx b/docs/api/qiskit/0.45/circuit_singleton.mdx index 4be8535fdc2..f9f9ba1457d 100644 --- a/docs/api/qiskit/0.45/circuit_singleton.mdx +++ b/docs/api/qiskit/0.45/circuit_singleton.mdx @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonInstruction - + A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") which has an immutable definition and any instance of [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions. @@ -56,7 +56,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonGate - + A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -64,7 +64,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonControlledGate - + A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -126,7 +126,7 @@ Subclasses of [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstru #### \_singleton\_lookup\_key - + Given the arguments to the constructor, return a key tuple that identifies the singleton instance to retrieve, or `None` if the arguments imply that a mutable object must be created. For performance, as a special case, this method will not be called if the class constructor was given zero arguments (e.g. the construction `XGate()` will not call this method, but `XGate(label=None)` will), and the default singleton will immediately be returned. diff --git a/docs/api/qiskit/0.45/dagcircuit.mdx b/docs/api/qiskit/0.45/dagcircuit.mdx index b32eb841743..e010b959382 100644 --- a/docs/api/qiskit/0.45/dagcircuit.mdx +++ b/docs/api/qiskit/0.45/dagcircuit.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -42,7 +42,7 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError - + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/0.45/exceptions.mdx b/docs/api/qiskit/0.45/exceptions.mdx index e298892eb70..a47a563fc38 100644 --- a/docs/api/qiskit/0.45/exceptions.mdx +++ b/docs/api/qiskit/0.45/exceptions.mdx @@ -22,7 +22,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: ### QiskitError - + Base class for errors raised by Qiskit. Set the error message. @@ -38,7 +38,7 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any @@ -48,7 +48,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError - + Raised when an error is encountered reading a user config file. Set the error message. @@ -56,7 +56,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError - + Raised when the file provided is not valid for the specific task. Set the error message. diff --git a/docs/api/qiskit/0.45/extensions.mdx b/docs/api/qiskit/0.45/extensions.mdx index ceb00f8563f..e638c554bdd 100644 --- a/docs/api/qiskit/0.45/extensions.mdx +++ b/docs/api/qiskit/0.45/extensions.mdx @@ -36,7 +36,7 @@ The additional gates in this module will tend to raise a custom exception when t ### ExtensionError - + Base class for errors raised by extensions module. Set the error message. diff --git a/docs/api/qiskit/0.45/opflow.mdx b/docs/api/qiskit/0.45/opflow.mdx index 086d815b6b9..7d2b0333eed 100644 --- a/docs/api/qiskit/0.45/opflow.mdx +++ b/docs/api/qiskit/0.45/opflow.mdx @@ -194,7 +194,7 @@ $$ ### OpflowError - + Deprecated: For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.45/passmanager.mdx b/docs/api/qiskit/0.45/passmanager.mdx index 8dfe2fc3c70..0753dea2a4d 100644 --- a/docs/api/qiskit/0.45/passmanager.mdx +++ b/docs/api/qiskit/0.45/passmanager.mdx @@ -163,7 +163,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza #### PassManagerError - + Pass manager error. Set the error message. diff --git a/docs/api/qiskit/0.45/providers.mdx b/docs/api/qiskit/0.45/providers.mdx index 8a6b3fe060f..78010f76972 100644 --- a/docs/api/qiskit/0.45/providers.mdx +++ b/docs/api/qiskit/0.45/providers.mdx @@ -77,7 +77,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. @@ -85,7 +85,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. @@ -93,7 +93,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobError - + Base class for errors raised by Jobs. Set the error message. @@ -101,7 +101,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. @@ -109,7 +109,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendConfigurationError - + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/0.45/providers_fake_provider.mdx b/docs/api/qiskit/0.45/providers_fake_provider.mdx index 991a94e78a9..8f5ce80ac3a 100644 --- a/docs/api/qiskit/0.45/providers_fake_provider.mdx +++ b/docs/api/qiskit/0.45/providers_fake_provider.mdx @@ -211,7 +211,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeBackendV2 - + A fake backend class for testing and noisy simulation using real backend snapshots. The class inherits [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class. This version differs from earlier [`FakeBackend`](#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.FakeBackend") (V1) class in a few aspects. Firstly, configuration attribute no longer exsists. Instead, attributes exposing equivalent required immutable properties of the backend device are added. For example `fake_backend.configuration().n_qubits` is accessible from `fake_backend.num_qubits` now. Secondly, this version removes extra abstractions [`FakeQasmBackend`](#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.FakeQasmBackend") and [`FakePulseBackend`](#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.FakePulseBackend") that were present in V1. @@ -221,7 +221,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeBackend - + This is a dummy backend just for testing purposes. FakeBackend initializer. @@ -234,7 +234,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeQasmBackend - + A fake OpenQASM backend. FakeBackend initializer. @@ -247,7 +247,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakePulseBackend - + A fake pulse backend. FakeBackend initializer. diff --git a/docs/api/qiskit/0.45/pulse.mdx b/docs/api/qiskit/0.45/pulse.mdx index 495f2460c43..db0e0078dec 100644 --- a/docs/api/qiskit/0.45/pulse.mdx +++ b/docs/api/qiskit/0.45/pulse.mdx @@ -73,7 +73,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -620,7 +620,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -675,7 +675,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -2771,7 +2771,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. @@ -2779,7 +2779,7 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet - + Raised if the builder context does not have a backend. Set the error message. @@ -2787,7 +2787,7 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder - + Raised if no builder context is active. Set the error message. @@ -2795,7 +2795,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError - + Raised if instruction duration is unassigned. Set the error message. @@ -2803,7 +2803,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError - + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/0.45/qasm.mdx b/docs/api/qiskit/0.45/qasm.mdx index cf9f858253a..e7d580cf45d 100644 --- a/docs/api/qiskit/0.45/qasm.mdx +++ b/docs/api/qiskit/0.45/qasm.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.qasm ### Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. @@ -32,19 +32,19 @@ python_api_name: qiskit.qasm ### OpenQASMLexer - + A pygments lexer for OpenQasm. ### QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.45/qasm2.mdx b/docs/api/qiskit/0.45/qasm2.mdx index dfb2b4cb7c8..fe665f7c33a 100644 --- a/docs/api/qiskit/0.45/qasm2.mdx +++ b/docs/api/qiskit/0.45/qasm2.mdx @@ -85,7 +85,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -103,7 +103,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -164,7 +164,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error - + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -174,7 +174,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError - + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -184,7 +184,7 @@ When the exporters fail to export a circuit, likely because it has structure tha ### QASM2ExportError - + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/0.45/qasm3.mdx b/docs/api/qiskit/0.45/qasm3.mdx index b718045e47d..4535bb2ed47 100644 --- a/docs/api/qiskit/0.45/qasm3.mdx +++ b/docs/api/qiskit/0.45/qasm3.mdx @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -107,7 +107,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -119,7 +119,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -222,7 +222,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.mdx index f72c52a9c39..db4b32f72e0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.mdx index 93d1f71ecac..dc2410a9bbe 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.mdx index e6e3a8128ad..abc5e80290d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.mdx index 38d3b8eaaef..faf992d0b1b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -87,7 +87,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -111,7 +111,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.mdx index 07e497a914d..f7101769588 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.mdx index 5116aa04e08..28a9b470f30 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.mdx index db4dc086bcd..0a6587ec951 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.mdx index afc9a84d9ed..1bca877b8bf 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.mdx index 6780bfdafb7..98816938d45 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Deprecated: Eigensolver Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.mdx index d918fc0494f..787c939d894 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.mdx index 844d0ce82f6..dee242ad564 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Evolution problem class. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.mdx index 44aa057cc88..43b1e0c9ce9 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `AlgorithmResult` Deprecated: Class for holding evolution result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 2ed400fa0e0..0f48cbf3d43 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 0602c85206a..a595912188d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.Grover.mdx index ef906e1e312..d7fbf1ca0ac 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -168,7 +168,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.mdx index 8a00c252b40..ec7e6790652 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index b093b8b504d..d7543c7b031 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 32d6154333d..59097d26984 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.mdx index b8ae8904ba3..75929ed9ae4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Imaginary Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.mdx index 391af8ea272..ed584232eac 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index e34bae98cb4..d99df5d4d0a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index c462f1ce5dc..b8c2d148689 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.mdx index 66e23305a69..e9d50d2feb7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index 3447bf0bbf9..18af546aa5a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index de702c20785..facbc06957b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.mdx index d4a1ff615b9..6848db7792c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Minimum Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.mdx index db837d2635a..47b922e2d15 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Deprecated: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.mdx index 31ad4a77254..76f7ee65086 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: NumPy Eigensolver algorithm. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.mdx index f9a3475f38a..72e5cafa4cc 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Numpy Minimum Eigensolver algorithm. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.mdx index b47c7bad41a..4e98957b3d3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.mdx index 6a710d61939..e8e7b74a112 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.mdx index ae3f06879d3..a5ec632d5e9 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.mdx index ed0de3abb57..65f0f84a8af 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.mdx index 88840b730b4..7e27f8a92f7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.mdx index 406b4c882b6..fe00917ba05 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Deprecated: Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.mdx index c598a296bc1..d28dfaa3679 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Real Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.mdx index 1bb9dfd9107..bc15896dc2f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.mdx index e3cd258d0d5..04a02efe5a6 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.mdx index 35e604cddeb..6c8881c5c90 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.mdx index 778190d8611..809a051d53d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time evolution problem class. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.mdx index 01543d9b745..840923f0f15 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.mdx index c2b14577bbc..a2ed01f65b3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Deprecated: Quantum Real Time Evolution using Trotterization. @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.VQD.mdx index a029a4e6246..0c05b0f103a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: Variational Quantum Deflation algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.mdx index c6465e160e4..7a9287101ce 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Deprecated: VQD Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.VQE.mdx index 7caf72714fb..3d546f4cdc3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Variational Quantum Eigensolver algorithm. @@ -239,7 +239,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.mdx index aca42803180..c4b47dec281 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.mdx index 90936d2f01c..b3408c85879 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.mdx index d0cbd73e8e4..44656957018 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index 5ec2acc5938..8bfcc569dc3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index bda89145347..b282fb3005a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index 47afceaba46..924beb943c1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.mdx index 2099bb6d8f2..28b23097d1c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.mdx index 02d4a55d00f..1dd2798fe2f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index f913deda36e..5628d6ca7d2 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.mdx index 81a40066e5a..d422eeb79da 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index 87a595f6055..48b37df168b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index e0e36735b93..a0596a2d33f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 18339d48f6a..a5a2f0d07f8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index 51e47293c1c..87a5410d588 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index eb47c0cb87c..6bdfb4e1d95 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.mdx index 3b6392277e5..06a113e977c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index 92b5eae6e7c..5f2504b17b2 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 806cc4324bc..fa4ab3a7d1a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index e2d966b1c55..24e3015ad7d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.mdx index 0f5110be61d..dff1878faa0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.mdx index 22de1153680..b6794cbbcbf 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QFI. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.mdx index 26576491a03..2346f0f3755 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QGT. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index 4e6b3f5c9c4..85cbbc3f78a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.mdx index 2a9ef59103d..b5ca82f683b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 77494e17bbf..286b9fe1eee 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 301b906b83b..c661ec079d7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 75e79766956..edfae9175e5 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of SamplerGradient. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index 27a3c32f35b..f985d9b5c1a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The Adaptive Variational Quantum Eigensolver algorithm. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index d4ade66c354..4bb8b273177 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index b47a8fd75eb..ffc0f868a9f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index 1bc1d37198c..dcb3e0b3a80 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index 9a43cf8a4c6..8c259ac37cf 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index 02be4ed9d10..95618255b11 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 84c7f2a35d6..fa7774cd5a1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index 2b9fcbe9c25..1a06a9ca9c8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index d7c4397d320..342deaa160a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 90c442bfd73..f3ac73b6535 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -145,7 +145,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index 0fed343cad7..4ef5fedb14b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") VQE Result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index b0ea13328e5..13c67c28232 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The variational quantum eigensolver (VQE) algorithm. @@ -149,7 +149,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index 8e2c41576e2..65819c117b4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.mdx index 16501053ff0..1c6c831ebc6 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.mdx index 39daed16bd3..d9bd4598997 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -139,7 +139,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -205,7 +205,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.mdx index e2d2f4491c2..c40cad2b46f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.mdx index caf342c0bcb..5cff47d1f54 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.mdx index 6dbbb5dd60e..25c42b36bf4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.mdx index e964ce1fe29..687ba59ed47 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.mdx index f89e6e2201d..42dd3d1d667 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.mdx index a19dced6f66..d18b2292d6a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 86e2875dd81..47a92e7b65c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.mdx index b185c62cb56..11e085eedc4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `NLoptOptimizer` ESCH evolutionary optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.mdx index d0c70037a93..a041cd83a5d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.mdx index 22cf2f051c1..f626d196ddd 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -312,7 +312,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -416,7 +416,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.mdx index ba0ee247562..87e25f97e23 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.mdx index f37da731118..d95702162c4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.mdx index 0a41329d6aa..c18d1ac8b70 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.mdx index e83bee99f58..af48874f657 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.mdx index 5bb405665ff..82ed011d30d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index 8d276a3d6e6..30f65c48976 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx index e65aa743908..68a4aea59f4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -196,7 +196,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.mdx index 587acab2ea8..f2f51a36783 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for optimization algorithm. @@ -113,13 +113,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.mdx index f0a6e25d886..cdf6afc309e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.mdx index 9721eeabda7..62bc7d6d78c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index efe7209106b..1e555fab0ec 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.mdx index 1739dad1397..2f40cf05cc2 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.mdx index 51cb4c86c7b..6fefea8f455 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.mdx index 57ba9c52f26..a21d43cf89d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -221,7 +221,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -231,7 +231,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -278,7 +278,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -372,7 +372,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.mdx index c67cd8099ed..b1b26ab6aa8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -124,7 +124,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.mdx index 0fa0bc41049..f175a971225 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.mdx index 4470e3e7a6e..d26648dcada 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -213,7 +213,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -247,7 +247,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -263,7 +263,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -357,7 +357,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 1ff8c45f9db..801ca0d29f6 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index f1e12b59128..40472ea48ec 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -202,7 +202,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -218,7 +218,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](#qiskit.algorithms.optimizers.SteppableOptimizer.step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](#qiskit.algorithms.optimizers.SteppableOptimizer.ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](#qiskit.algorithms.optimizers.SteppableOptimizer.tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -238,13 +238,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -312,7 +312,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -346,7 +346,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.mdx index 5f48dd896f2..c390e8bd79f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.mdx index f1f729789f2..ecc87b689c0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.mdx index 0f582b2eeb8..2c94eccec0d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index 1de7f5516e6..cda3ee01229 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index 2cdbd6b6a84..1f64248c8d4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index e2fbc1ee8f1..a874c4c9ea7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 6d2ddad1cf5..94d0fe0769f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index 13537cbfa0b..d423656fab7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 3a2152d1187..324d3314f0a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index d2df5531262..a6fe70fd1d3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 5a5320c3e0a..0316521170c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 3416ed59433..46395674543 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index 51ce3901cf5..40f45b4a4bf 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index 47273df4f58..2997f010c19 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.mdx index efe1870a6e0..0dbabf0b461 100644 --- a/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") Class for Run Configuration. @@ -67,7 +67,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.mdx index c8c9c442fc7..1ac8959957e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.mdx index 7434f88635b..711dd272532 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.mdx index 2a2f8769ef7..a577d73ee25 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation # AnnotatedOperation - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Annotated operation. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Bit.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Bit.mdx index 9748dcf3834..2e2bf47089a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Bit.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Bit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Bit # Bit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic bit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.mdx index e487bdbdf13..28ca2da5fdb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.mdx index 098d492118c..94009c208b9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.mdx index e8cc6da9d16..dfac61f385c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Clbit.mdx index fba911c5b8b..fe41aba0995 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a classical bit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.mdx index 7c2da78683a..5543d207fd0 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CommutationChecker # CommutationChecker - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This code is essentially copy-pasted from commutative\_analysis.py. This code cleverly hashes commutativity and non-commutativity results between DAG nodes and seems quite efficient for large Clifford circuits. They may be other possible efficiency improvements: using rule-based commutativity analysis, evicting from the cache less useful entries, etc. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.mdx index 108e4c3b97b..8fbbed56623 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.mdx index 369300fb99f..91911a4202a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class to encapsulate all control flow operations. @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.mdx index 776610f173c..8f1aae9f73a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlModifier # ControlModifier - + Bases: `Modifier` Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.mdx index f4930a40e28..071130e7362 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Delay.mdx index 42661c23c79..630ef4076c7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.mdx index 564e7facfb5..28375d108f5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.mdx index dc5716eda67..34d59cc9caf 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Gate.mdx index 62ef5979991..4874bc86b13 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.mdx index 15b2c58944d..d2f73c0b1aa 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Instruction.mdx index 3b75fa14c04..223e036f2d1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.mdx index 3f3b7bf781a..548a7884017 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.mdx index f5a9357aceb..fc47dd6ef4e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InverseModifier # InverseModifier - + Bases: `Modifier` Inverse modifier: specifies that the operation is inverted. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Operation.mdx index c10d1227697..4748503da22 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Parameter.mdx index 73f9ee78013..ccb68ba1482 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.mdx index 30be9ebb50a..4b525d96801 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.mdx index 242a3d82fd4..dc7cc3281b4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.mdx index 414ae1a6b18..0aa019d680f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.PowerModifier # PowerModifier - + Bases: `Modifier` Power modifier: specifies that the operation is raised to the power `power`. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.mdx index 17b73bbdf38..405786a7cfc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Create a new circuit. @@ -482,7 +482,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -588,7 +588,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -598,7 +598,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1407,7 +1407,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1430,7 +1430,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -1452,7 +1452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.mdx index 4586d74455f..5ecbfec2303 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Qubit.mdx index 0a169e65950..6f0dad341ff 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a quantum bit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Register.mdx b/docs/api/qiskit/0.45/qiskit.circuit.Register.mdx index eb51b99793d..2a7da441b16 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Register.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.Register.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Register # Register - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic register. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.mdx index 2e0a025b74f..e84ced0aec3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp # SwitchCaseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") can be used to represent a default condition. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.mdx index 67fa2723761..e46ed26c62a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 1d8c25e13a2..2ec38cf278a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `ClassicalElement` The Boolean Expression gate. @@ -237,7 +237,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index fab5db6e3fd..efb7b95c8a4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `ClassicalElement` Represent a classical function and its logic network. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 53c36d7533a..01d8705fc2a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index c64aa6b886d..f989f242748 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.AND.mdx index c2f231f1951..c21581efb91 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.mdx index a8e53c6dbb8..d0a904d79a4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.mdx index 34a33a2631b..e701e5054d3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.mdx index 5620fbffcdd..eae497a684b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.mdx index 49768621b18..af7dffcea14 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.mdx index 0e39db52df9..b7055069550 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.mdx index 5844534ad1b..8b9382be94e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCZ gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 8a443327df7..711c14a5755 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.mdx index 162977be380..d73f7dbc645 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.mdx index bd3f73dd8cc..fbc6ed7ff08 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.mdx index 9e79b52c2a6..ad9ba60e0b9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.mdx index 12745e5ef4a..e4d1780e857 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.mdx index 327c58e914e..e7d223138a0 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.mdx index c817b64cd50..9a8448e82fc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.mdx index ee12aedb173..7f058b5502a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.mdx index a352b5d6a24..208d4a4dd63 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.mdx index 4e7db95203b..ffb19d6eb90 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.mdx index 6beaf3526b8..1f17216ed36 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.mdx index ac4e2db234c..73b9e6f76d0 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.mdx index 87122d7ffc6..d24779dd931 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.mdx index c2a9d95df64..ffe20a0de68 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.mdx index 6b3815851b8..b91f963ced7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.mdx index 059724da9db..39242e4e9df 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.mdx index cc96b7019c6..b6512da9e76 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.mdx index 8f95f6cbde6..f8180b8badb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.mdx index 40cb36d5b8e..564b1b0e41b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate # DiagonalGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Gate implementing a diagonal transformation. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.mdx index f31c1ccd375..0cfd9d31393 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.mdx index c9de09f964d..00c15d14914 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.mdx index 6e02c79575a..b2aec50374e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index be3af60ca15..47d464639ee 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.mdx index fb43348757a..ff2b073c4ae 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.mdx index 654c2095bdc..7d8c1870ab3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.mdx index 6d688b4e752..4f4f920c2e3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.mdx index 0961c0bbce8..b5ab0e59dfc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.mdx index 515127d0e13..45639f6403c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GR.mdx index 416dda4c93e..3814373f92a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.mdx index 55fd01f7e54..258950a0f6b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.mdx index b6f339dd605..1f8487b118c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.mdx index 87ff324f539..20397076972 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.mdx index 56e6374782a..d285cd5717b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate # GlobalPhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The global phase gate ($e^{i\theta}$). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.mdx index f8b70cad61c..30ea534c3fb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.mdx index 7ffc1a25b07..daf31ce63c7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.mdx index 712a671aeb1..f5e01c162ae 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 64fb3157355..e1702f16a39 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.mdx index 9c625dfc1f3..b576390a8ee 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate # HamiltonianGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hamiltonian operator as a gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.mdx index 267bf06a45b..650015de4be 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.mdx index 45025f93ebb..0e599913f7f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Identity gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.mdx index b279c379c35..7183fddf0f1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.mdx index 9cf2229f0db..b0a91f94443 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Initialize # Initialize - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.mdx index 068f06780a6..0f7d7cd80a5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.mdx index fe0f9cc0ebd..3265eea2ce9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.mdx index fe1cd8004de..c9d0de87c49 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Isometry # Isometry - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Decomposition of arbitrary isometries from $m$ to $n$ qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.mdx index f0464fd2b6c..9cc77b58bab 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.mdx index 03672fa5abb..9fa9b6ebc2e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.mdx index f8af5fa8160..7617357f6c4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.mdx index 23b8e0a84e1..0545b892b6d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.mdx index 10227461a17..44159780f05 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.mdx index 37f151805c2..8f77e4a3b74 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.mdx index 1f1e8ab0ef5..62be3ef4377 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.mdx index 8ba3fb8b0da..a564c43c5a6 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.mdx index 6b8f7538577..b06f3737981 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.mdx index 4c7fa1f0e1e..9ab990b2a4d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.mdx index 4e9f14a2ab9..23eac5f6080 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.mdx index 3ecc221bdd4..1a80e884737 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.mdx index 9377011324f..221daf56737 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.OR.mdx index 15100de8dad..27a007ace03 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.mdx index 7d6ec85b024..d46131257f9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.mdx index 29bfdcbfcb2..6d578393420 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.mdx index c0a3f466019..1c60fb220ae 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.mdx index dfa68cc6458..e55955959cb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.mdx index 1b2106fde80..c823ccd99af 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.mdx index 6c9e8f73e0f..48790bf1173 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.mdx index 0501a880412..9307f21f82e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.mdx index a9bed1fce7b..86ae9faf52b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.mdx index 4b6a0eb7b60..6264add8765 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -232,7 +232,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.mdx index d21e28b0f4b..4386bab13c9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index b6f71af064f..99aa4e041dd 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 94c92587cb3..099f4228ca3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.mdx index ec36a4a247a..d0bcb12d8e7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.mdx index 98f4a264004..931116bac8f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.mdx index 9b42d8bf585..af1f8a22d6f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.mdx index fdab26c3d36..eeb05fe7671 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -239,7 +239,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.mdx index 763b8e79ede..6349632383a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.mdx index 7eb92c5fecc..219405c854c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.mdx index 7c2ca38a2c8..bdec12e032a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.mdx index c7aa2dd6a55..8567e016915 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.mdx index 39dd9c3cdd1..73cdc0cb8c6 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.mdx index 00083010219..b6580b2952a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.mdx index 68675b988fc..20bdacc380d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.mdx index 79db81e325e..9afec50bed1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.mdx index 17c04c4db5a..862db971277 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.mdx index 71f33c97c61..002f957ab1e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.mdx index 609e5a8ee31..1e74b6850ff 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.mdx index b1c67202282..fcc21d383e9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.mdx index 55b413caeb5..9f5432cf234 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.mdx index dfc2567041d..5ae7ce86e1c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.mdx index f3d06ad9893..519129ffa56 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.mdx index 7594fd26f23..b5961cddbbc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.mdx index 9f3442521ff..76ddafd5a92 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.mdx index f0001c4e21a..ae55669a0d3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.mdx index 6dee0cccdd2..ad76461a503 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.mdx index a82402b539c..832555c30ef 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.mdx index 3ff7b1e0c5c..b5ed76b72c7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The SWAP gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.mdx index a3e5375d0a0..7feb3b2b358 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.mdx index 4d7b770348a..c3964bd7e33 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.mdx index 396d6e034c4..bef581fd351 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.mdx index 1f635385fe5..081a7632fff 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.mdx index f8a2bfba0e4..cc09dd80d45 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.mdx index e6853f61554..888bc916a57 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.mdx index 56606d7439f..642c96d444d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCGate # UCGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled gate (also called multiplexed gate). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.mdx index 388e3fbf5c7..44c43b7b85c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate # UCPauliRotGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled Pauli rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.mdx index 4586afa6569..f29a1986e99 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRXGate # UCRXGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-X rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.mdx index cb46393f100..3b8aa9a6270 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRYGate # UCRYGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Y rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.mdx index 3e385ba8f08..46fb18f89cc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRZGate # UCRZGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Z rotations. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.mdx index 229520f8dec..6e297fb83a5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.mdx index 285f49409dc..91d72f6789b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.mdx index 4fe841830d2..cd3c212d54b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap # UnitaryOverlap - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.mdx index 3db46c774ec..87475c8d2f3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.mdx index 5c65415a6c0..cb5ea2929b7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.mdx index eaea27eea7e..7fe0c23518b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.mdx index 8b7b51ae7b8..976457d48ce 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.mdx index 74dd1dd1016..a077a564ada 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.mdx index b044a41ce01..8abcb6ad9c7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.mdx index d6fe37574bb..3d586acad7e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.mdx index 42970677bc1..3e1c2ef09c8 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.mdx index dd2c631a7c8..b28b119516b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.mdx index a607c6bd990..c788dbd005b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.mdx index da95e0a9641..a8c363e0054 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") iSWAP gate. diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.mdx index 474387e05fa..7d06ea8f62b 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.mdx index 0efbbcd8145..9c1968a308a 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent the information at a node in the DAGDependency(). @@ -91,7 +91,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.mdx index 4954f6ec5fc..8956e3dd07d 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.mdx index b4d2a7ad82b..250d9c89760 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14.0)"). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.mdx index 4fecf6148bd..3ccf44edbf2 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14.0)"). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.mdx index c241207ec60..61106fffdd1 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -43,7 +43,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14.0)"). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.mdx index e61cfbe194a..a40c8266f12 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14.0)"). **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.mdx index d3c28322be2..1ecd9c5e405 100644 --- a/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit unitary. diff --git a/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.mdx index 642722bdc82..18b4ff8759a 100644 --- a/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.mdx index bc7edc09db5..f3dca66808b 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -63,7 +63,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Returns** @@ -95,7 +95,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -177,7 +177,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -209,7 +209,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -263,7 +263,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -309,7 +309,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -327,7 +327,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Returns** @@ -351,7 +351,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.mdx index 102ab1898bd..222cb350be7 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.mdx index c10097bd625..fee973b1776 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.mdx index bf8543bf060..d5bdcc42fe8 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.mdx index 4aca6197fc7..0994f718f41 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.mdx index 2f8eb03271a..54471c18e6c 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -169,7 +169,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.mdx index e52acf6162d..ffc11f50f50 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.mdx index 3afe8f57c91..9b03e2f5373 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.mdx index 38904509de6..86d4e059a78 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + 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.45/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.mdx index babdfbbd3dd..77a6b39a833 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.mdx index af56a8bf2d7..1d377834aac 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index a9639095327..ec651caa152 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.mdx index 978e1a8f6f6..b477708298d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.mdx index 125dad5d2ae..92bd08bb166 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.mdx index 27696278f88..588a38a099e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Deprecated: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.mdx index c29a7ae0962..92b87aff638 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.mdx index a91a012ae66..c2649dbc145 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.mdx index 0b5e34ddccd..b1e7d2c2e78 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.mdx index c86a73effa4..8d9065a2e5b 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.mdx index 104c151f3bd..28d5bcdf40a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.mdx index a6a1e8e5326..f8e0e2c4605 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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.45/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.mdx index a971239e248..fa4bb9e082e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.mdx index d2b1e5e10db..c7d5bb95e60 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.mdx index efa9a95d5b4..eed5779c281 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to gradient operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.mdx index 3f3b9ba31e0..4fa34c14d8e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to Quantum Fisher Information operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.mdx index 2e7b55f2395..eb232760454 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Base class for differentiating opflow objects. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.mdx index e0cf4641d88..0a747bb4d1a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.mdx index 3653361794d..fbc0808faa7 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.mdx index ecf88d17d9e..665ad3d54fc 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Deprecated: Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.mdx index ef0adf2b594..847efb421e1 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.mdx index d683682cbfa..2cee333e663 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. @@ -89,7 +89,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.mdx index c58afc8ebaa..a70979524ab 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Deprecated: Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.mdx index 4c2c8225a6b..58ca8c06ead 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.mdx index b667b07f332..5a1080be326 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.mdx index 5472fc04ea9..4ddd2ffbe3a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.mdx index 8ad3c587036..bf253a74836 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.mdx index d8af9cd65ab..f646666f61a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.mdx index f2ea1827f8f..9876040e514 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.mdx index 2cb8e611721..0d23b525d2d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.mdx index 86e3ab64a6b..e4d5c33efb1 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.mdx index d02a735c8d4..2d5d3c06e13 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -199,7 +199,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 4a89531de0e..aa74f956d82 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index 74ec826e575..e5396956690 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Deprecated: Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index d82a137f803..edb69fb4ac8 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Z2 Symmetries @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.mdx index ab7b1223381..2cce7598249 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **Deprecated: A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.mdx index 2279956d5d5..54d64018fe8 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.mdx index becf464e80b..aba91065f52 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.mdx index 3f27423d5bd..ed18afae8a1 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 1c63ff767ff..2ce63c08939 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.mdx index 0a5a52e7fbb..e76321b7c20 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.mdx index a73689a44ef..75ccf6c9bc7 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.mdx index 0f203df6c69..1430efe8481 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BaseController # BaseController - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of controller. @@ -45,7 +45,7 @@ python_api_name: qiskit.passmanager.BaseController ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.mdx index b85b468ec4c..125d111b172 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BasePassManager # BasePassManager - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Pass manager base class. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.mdx index c42e575e085..6ccf4550731 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.ConditionalController # ConditionalController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A flow controller runs the pipeline once if the condition is true, or does nothing if the condition is false. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.mdx index 7ffcf9df8e3..7a0d159da86 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.DoWhileController # DoWhileController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") Run the given tasks in a loop until the `do_while` condition on the property set becomes `False`. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.mdx index 65992536c0d..739bff312d7 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.FlowController # FlowController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A legacy factory for other flow controllers. @@ -57,7 +57,7 @@ python_api_name: qiskit.passmanager.FlowController ### add\_flow\_controller - + Adds a flow controller. @@ -72,7 +72,7 @@ python_api_name: qiskit.passmanager.FlowController ### controller\_factory - + Create a new flow controller with normalization. @@ -112,7 +112,7 @@ python_api_name: qiskit.passmanager.FlowController ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. @@ -133,7 +133,7 @@ python_api_name: qiskit.passmanager.FlowController ### remove\_flow\_controller - + Removes a flow controller. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.mdx index 1c88a6455b8..3ca09e5f2bf 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear # FlowControllerLinear - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A standard flow controller that runs tasks one after the other. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.mdx index c915e24cf0a..dca0888b236 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.GenericPass # GenericPass - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of a single pass manager task. @@ -49,7 +49,7 @@ python_api_name: qiskit.passmanager.GenericPass ### run - + Run optimization task. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.mdx index 3f8923bdcdb..8ab7cc7c0e5 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PassManagerState # PassManagerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A portable container object that pass manager tasks communicate through generator. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.mdx index 4f01bd2e003..58ceaa60b81 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PropertySet # PropertySet - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A default dictionary-like object. diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.mdx index cb39acf0b8a..baf3321ebee 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus # WorkflowStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Collection of compilation status of workflow, i.e. pass manager run. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.mdx index 56c629e5746..f6de1aab112 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.mdx index 01db6007ddb..f560c4aa76a 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.mdx index e11019b3646..9c8547decd0 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Estimator base class. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.mdx index 8a46e546f63..7f2f6ce6afd 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Sampler base class diff --git a/docs/api/qiskit/0.45/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.45/qiskit.primitives.Estimator.mdx index 2829e0655e7..818ba15815f 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.mdx index b9f78609958..f9c1d6cf977 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.45/qiskit.primitives.Sampler.mdx index 768cdad3925..7bc7d590b9a 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] Sampler class. diff --git a/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.mdx index 2e765b017bb..25ecb0ebb41 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.45/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.45/qiskit.providers.Backend.mdx index cc305b7877a..5a8281739d6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.45/qiskit.providers.BackendV1.mdx index 1c88fe85c64..8dc5956dbae 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -21,7 +21,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.BackendV1 In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -141,7 +141,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.BackendV2.mdx index e9aebcfb53c..6069e1e50b8 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -25,7 +25,7 @@ python_api_name: qiskit.providers.BackendV2 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -324,7 +324,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.mdx index c72d903d118..859f96896d1 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.45/qiskit.providers.Job.mdx b/docs/api/qiskit/0.45/qiskit.providers.Job.mdx index 4eec3b94f1a..f7a8ab222fa 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.45/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.45/qiskit.providers.JobStatus.mdx index cbec5efea25..bfb2be1e75f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.45/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.45/qiskit.providers.JobV1.mdx index 78c41760a3f..6145fb352ab 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class to handle jobs @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -105,13 +105,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.45/qiskit.providers.Options.mdx b/docs/api/qiskit/0.45/qiskit.providers.Options.mdx index 27b8237a61e..1176a62b1ab 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") Base options object diff --git a/docs/api/qiskit/0.45/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.45/qiskit.providers.Provider.mdx index 18ddc9a6325..3cbd9e19f34 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.mdx index aa9a251e78f..5d94e99365c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a Backend Provider. @@ -23,7 +23,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.mdx index 901168c120c..fae47595953 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.mdx index e71bbd42a1c..460121828cc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.mdx index fcc0308ee6b..2288107eb85 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.mdx index cffd2e7c078..a265c520905 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.mdx index ceb3e8c23ef..c1f48b4a86a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of an OpenQASM 2 simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index 19f3d702ecb..6fb39428b94 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 45765c77028..c22db370b68 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 6e943c5a031..54608d04f71 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") Configurable backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.mdx index dfdf01f2879..c73aeed2cdc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 1Q backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.mdx index e90f2ec813e..5bba975e3e9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Almaden backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index c2aed47f0af..34e786d77d8 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.mdx index c7c48ef95bc..d62f39e0367 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 8c31b649e24..820324c8621 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.mdx index 4c436581553..695b1b1d590 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.mdx index 5f08e7b0295..13a58079cbc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.mdx index 754bce43999..a98254a81d0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index a4daa829549..883037fc28e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.mdx index a658b72f488..fc275c3bb21 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.mdx index 38445e9ccef..b0655000db0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.mdx index a341cd4463d..4fcd128e43f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.mdx index 309b467a9f7..775144145b2 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index 7fafada8106..4a7c9694270 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.mdx index e2f5c2ee2a6..07ffbc7ce97 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.mdx index e1fc4d9a36f..da172a27c10 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 1b9ad880798..5cf89ef65be 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index 0edc0f05344..5a2a6e3b856 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.mdx index 3bee0027e10..6a9a7e5a6b7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 1cfce64f593..e47321c3c75 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.mdx index 304e31dee7c..26640ab6dca 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.mdx index 20e0036c603..5a40c1a723e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.mdx index dfa71965b91..01c90624742 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Cambridge backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index 64e52239c2b..4bf62ca0b72 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Cambridge backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.mdx index ebf89adac12..09f15ff2ee4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index 93773d02540..3d8c7576781 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.mdx index 7829ac593a2..fbefbfe3532 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.mdx index f64e3ee2184..8d3e4b82c14 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.mdx index 87cd5ffc015..6753b7d0fcb 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.mdx index 3f304809032..9921f57c813 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index f8b02df06a5..c0756b0b7e3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.mdx index 34425a681ce..37e2238a895 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.mdx index 647ea48a5e5..9e424c02ebb 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.mdx index 7e7a1f10ad4..7b7955287e0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 1bd1b51bb77..82e0adda7cc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 4c37536edf8..9d95c4847f7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index 43bcf024e95..b71adf0ce64 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.mdx index b1f399b22ef..4fc9e3eaa52 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.mdx index aeee59ef9c2..3b3d2b1fe90 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.mdx index be4b38dc386..ce5e3276705 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.mdx index 86c7042e8e0..1087e128c97 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.mdx index e05823856c2..3dd49dffe2a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.mdx index 42a06bd953b..933fa6d4ab4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.mdx index 73de4f50e79..f671f240d69 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.mdx index 2c817a8c14d..a5fb83803de 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.mdx index 588aeaa143d..f6541e29ff9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Manhattan backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.mdx index 61b4b45721e..a8c44641d08 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Manhattan backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.mdx index d76b992c539..1170be97382 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.mdx index d08732b5df9..50077510d9f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.mdx index d2c24b11f62..a39cadc4712 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index b0f739cc147..977ca2b7794 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.mdx index 79d8cf6ce78..2e59351d29e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 69cef3ee7ba..4e6b77070a7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.mdx index 06b9b9f2f20..b3a705df656 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 96fad74d80c..740bc605aca 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index 6b0b57fbffe..05b970afe75 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.mdx index 03c5a03561e..a37f26f2b36 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 8132691615d..ab4a5034d9a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 8eccafd86c1..e5dfed54ffa 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 89cae4ec49e..f1a710ad5f3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.mdx index 9652440269a..75ade8e9d9c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.mdx index 798d91776e7..bb04173ce74 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.mdx index a49b6c928fe..8836420e449 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.mdx index 90b179dd2a2..87b85a600d3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Paris backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.mdx index 9621b423073..b28fdac5369 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Paris backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.mdx index 44ec8ca026d..4a29e186d12 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index d668e047851..1bea424a6bb 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index c80eafaa777..b81f53a2a5c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.mdx index 1622628511d..cb08c36afcf 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.mdx index 1b5ea049c60..a5703b982ee 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index 4415c54df8e..e2d260353b3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index d950f743e80..40af050867e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake simulator backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.mdx index d7176bed121..f0326a6dbe0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 6b50f425832..c716c5ed7ba 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.mdx index c6038dcafa8..ec33a93e2f4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Rochester backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 24de00cfb55..5cd1eecedc3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Rochester backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.mdx index 1bddd4114e9..27b7917965a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.mdx index c7fcd381264..b50f55968b1 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.mdx index d46b13ae3f9..776b64b63ab 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.mdx index 800cb6d5c30..c83dca59aaf 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Santiago backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index a55a4b30e4b..696d8e18d2b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Santiago backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.mdx index ea90f2c4321..d96e445e0a9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.mdx index cdf3253096f..3731941b4bc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Singapore backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index 5efc577d211..f5ac0ba8475 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Singapore backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.mdx index 37c60b3b594..44ffdce1179 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.mdx index cc3403b81b6..0d2a30e8568 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.mdx index f631944890d..534f98a0972 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.mdx index 484be2f8cb8..8d9498174f0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.mdx index 7e68c89daee..0f2d27c4d46 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.mdx index 8f41858b2a1..f13b7ad7ff8 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.mdx index 9808bfb1e00..11c65f4f5ab 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.mdx index 52beebedec9..ab5537efcec 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.mdx index 064f936d40f..1e6c6864dc2 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.mdx index d8e63160500..8fe949ffba9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.mdx index 5ad5aed4ce3..cef3cf7f70b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index 4bb172b5029..2125b08e1d0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.mdx index f8837c29918..178593cf245 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.mdx index 4e76bd6f6fc..a8b3ae1c166 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.mdx index 0f5e48c843f..40f3cfb54a6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -99,7 +99,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.mdx index 6a13fa1196a..da798807d8c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.mdx index 0a1816c49b4..d4bfa02447b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.Command.mdx index 8f43e357c11..299fdfa1cc0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.mdx index 8db4c6cd619..64f2c6f4b7f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.mdx index 66679115f2a..5b81e1f113d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateProperties # GateProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a gate’s properties @@ -44,7 +44,7 @@ python_api_name: qiskit.providers.models.GateProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.mdx index e78f1df9e00..1928cfeb4e6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.mdx index 8abb7c8849d..c80e9ab2d2c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Nduv # Nduv - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing name-date-unit-value @@ -50,7 +50,7 @@ python_api_name: qiskit.providers.models.Nduv ### from\_dict - + Create a new Nduv object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.mdx index da9fa3d9908..5274996b3ef 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.mdx index 2199669ea04..b6e2623e9fc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.mdx index 6f4d506263d..49540989f12 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing an OpenQASM 2.0 Backend Configuration. @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.mdx index 3f6b4378e8f..c336093d52f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.mdx index 8208c5d4aec..5be32805225 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") 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: diff --git a/docs/api/qiskit/0.45/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.45/qiskit.pulse.Schedule.mdx index 071212584b0..7d8b221d6d4 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -338,7 +338,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.mdx index e3272a94c0e..469a5a07beb 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time-ordered sequence of instructions with alignment context. @@ -480,7 +480,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.mdx index 33406ccd5f9..c1d1c2d2586 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.mdx index 2d75a2cead0..8e01318f662 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.mdx index f9cd9aa922f..f5795a3d41a 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.mdx index 0fce02a0b97..bef66054c80 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.mdx index 17c2eba048b..cdeb275005a 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.mdx index 1843f27a48b..3dd8f930af2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.mdx index b6c76b21f59..00e52787410 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.mdx index 23d0b82acd4..8e7c0aaa04d 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.mdx index 6884edb522a..b6787cccbdf 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.mdx index 5b449998840..63646a1a972 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.mdx index a6cec9f3ee3..90eb9b73f5e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.mdx index 8f3bbe8deb5..4482a3d86f7 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.mdx index 9fa80c04d3f..5a7a06e7569 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.mdx index 3ecb384a64e..85bd2cd9f89 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.mdx index 94e9e2cabc5..631717a08c5 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.mdx index 12cd3d091d4..fe09e29d336 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.mdx index 7719e660200..424d820d1c2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.mdx index ccaaddfe62b..7f47af9b768 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.mdx index 70a0ca9edef..1ed72086273 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.mdx index f2dc2cc9bf7..9f3eceaa4b0 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.mdx index 8738261f08d..d3c6c0415b2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.mdx index f7778bba610..b3380ee8341 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.mdx index c8726371af0..abb9a0ff4fb 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.mdx index e49747c29b0..1e331cc0d79 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `Pulse` The abstract superclass for parametric pulses. @@ -95,7 +95,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.mdx index b88b6f24783..52db8e2a16e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.mdx index 4abeccbd0ba..26d15cb9b07 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.mdx index 2760c5d695f..a6c9fba06cd 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.mdx index 6bb28efc90f..9142e58516f 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.mdx index feab10735c9..73d882913df 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.mdx index 9e275b4224c..b61d7f87f0e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.mdx index 8e3262f4311..12cdf3c361f 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.mdx index 4c1ff3c3706..eb68990e020 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.mdx index 405a125b670..c47b00ee3bb 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.mdx index b69e59a818b..3792610995e 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.mdx index fa295fb6c46..d2db50b2915 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `QobjDictField` A configuration for a Pulse Qobj. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.mdx index b1b9863eefc..c7c01ef8466 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.mdx index 31f7623bff0..eb0705e4872 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.mdx index 1ab756aee93..0ae11482e3f 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.mdx index 9727a739c20..281be80830e 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.mdx index 0b7218a8ccb..d143fe84c73 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.mdx index 3da6a833977..716c2a2dc20 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") A configuration for an OpenQASM 2 Qobj. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.mdx index bd0ffa16a23..338588bb12f 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.mdx index 3f30dd4ee15..ecdcb6c7932 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `QobjDictField` Configuration for a single OpenQASM 2 experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.mdx index 6b841726d24..b7f33501492 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.mdx index 1bf5ecf0968..47664a844e6 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.mdx index e82619d55f3..16b86bbf3e7 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.mdx index 46c1f4526b5..ecbea133cbb 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.mdx index 260e2af3716..e49ade6b10f 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.mdx index bd2d9c1a03c..a238c891005 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.mdx index cb287e9057e..a10dfb966dc 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.mdx index 219984e2310..18b82531933 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -265,7 +265,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -287,13 +287,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -341,7 +341,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_linear\_function - + Create a Clifford from a Linear Function. If the linear function is represented by a nxn binary invertible matrix A, then the corresponding Clifford has symplectic matrix \[\[A^t, 0], \[0, A^\{-1}]]. @@ -361,7 +361,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -385,7 +385,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -409,7 +409,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_permutation - + Create a Clifford from a PermutationGate. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.mdx index ef0236dd29e..60f27f5991a 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -184,7 +184,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -208,7 +208,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.mdx index deaebd4762f..8d8baf4627e 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.mdx index b250bfb2f80..c1b8f808806 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.mdx index ce3297502c2..b55289a86cf 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -254,7 +254,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -279,7 +279,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.mdx index 406b29d7802..eb9a53a9b5a 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.mdx index 9558e67bbb1..a99275b7e14 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -454,7 +454,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.mdx index 8e16d93ccae..3f3dcca2a08 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -424,7 +424,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.mdx index 24b9516b29f..712bd0e2d65 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.mdx index c99cda393cd..b839e3dfd5e 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.mdx index 8a00779057f..285dea54afa 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -365,7 +365,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -403,7 +403,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -429,7 +429,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -710,7 +710,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.mdx index bcb65da8e1d..0a3a2c44a82 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.mdx index f2caf1a9bf6..20aa2dff949 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.mdx index a0972faaa77..a521307179b 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.mdx index 23ead1e82e2..6ce055c195e 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx index 792668368a9..7a9ce849323 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.mdx index 7efbe78d667..f3a736b3cbe 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer # XXDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.mdx index 9ee953914a4..c743eb7a14c 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -111,7 +111,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries ### find\_z2\_symmetries - + Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). **Returns** diff --git a/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.mdx index 8a197ee8c26..2936291e067 100644 --- a/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.mdx index 39868398faf..16112609609 100644 --- a/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.45/qiskit.result.Counts.mdx b/docs/api/qiskit/0.45/qiskit.result.Counts.mdx index 51659da97bf..cfd0354cf34 100644 --- a/docs/api/qiskit/0.45/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.mdx index 04aab940aca..fa50e2b5134 100644 --- a/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.mdx index b8b4e6c99f4..82a10034e59 100644 --- a/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.mdx index dbe6cd70770..9247cbd0312 100644 --- a/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.45/qiskit.result.Result.mdx b/docs/api/qiskit/0.45/qiskit.result.Result.mdx index d209f60d1cb..8064e7e3cbf 100644 --- a/docs/api/qiskit/0.45/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.45/qiskit.result.ResultError.mdx index 03582330326..4ffc2a8dc07 100644 --- a/docs/api/qiskit/0.45/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.45/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.mdx index 81ff8a05b79..58aad26db22 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for evolution synthesis algorithms. @@ -33,7 +33,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.mdx index 17a38f5ef93..e09e28e16c1 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.mdx index 2f6bd0e7b4c..b603d62bb7c 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.mdx index bc8d060ee2a..4957dae102a 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -43,7 +43,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.mdx index 85f5966aa21..251b791babd 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.mdx index e8c227b544d..638201a378b 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.mdx index c4e3b12d13a..7c5dba18393 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.mdx index 35e183162c4..f8e187fa40a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `BasePass` An analysis pass: change property set, not DAG. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.mdx index 5360df6b676..5f655e1fe55 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Directed graph specifying fixed coupling. @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -224,7 +224,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -247,7 +247,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.mdx index 494631b4e26..d02485cd16b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.mdx index 234393941e1..1df6859e5d7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.mdx index 7db7b7d0067..972a794e27d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.mdx index 76b13f7567e..906c5caf886 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.Layout.mdx index 6097cbc41f0..7a3adacdc3f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.mdx index 2016fa2ad7c..ed93c71a5fb 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.mdx index ac75421a335..e741f98f420 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.mdx index 019d637b878..4bb7d034119 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A pass manager pipeline built from individual stages. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.Target.mdx index 7cc6923c1e0..8859f5ad3aa 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -256,7 +256,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.mdx index 1e3db40a408..2d353532e50 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `BasePass` A transformation pass: change DAG, not property set. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.mdx index 5ef37f1dbea..d8b6bd3de25 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Layout attributes from output circuit from transpiler. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.mdx index f2291bb3eb2..f362f46fd8a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 5e0380b7413..e35bd235e19 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.mdx index 7ec5d83f5d7..b1e12a98887 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 5cc14eb83aa..403ff8bfbf0 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.mdx index 5b9af485d47..1ef67c297ef 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.mdx index efed537843e..3d591e550c9 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 204984a30d3..483d973b95a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.mdx index 5eebfddd315..7e89e59d203 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a `coupling_map` adding swap gates. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.mdx index 50313f50f96..aba674b4dba 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.mdx index 005df5ec8f8..86ba32be934 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.mdx index cc0bfbeee50..900621d52c5 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back `cx` gates in dag. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.mdx index 5cf4ff15c8d..74a640ddb31 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.mdx index 198532ff8fa..bce8bead007 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.mdx index e42102a62d6..33b7a928bbf 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.mdx index de80a8a4dfc..74879daf088 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.mdx index 42208c89792..a4128da9173 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.mdx index ce6dd51b7d3..4d1b0652ac9 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `CollectAndCollapse` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index 61b42e27663..9a0d3e2aea7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. `max_block_size` specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.mdx index 8f95707e007..bc01965b87d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.mdx index 852ab260224..09bc25d567a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index a301be1bdb2..98533ea5732 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 3a921bc5a3f..d1d2c1b3af9 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 1378e5b775a..0efc2e8315e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.mdx index f090f9f2e20..3ed655ea31b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.mdx index bde404e4a52..9751ef9a7a0 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index 33266953b3e..59cf58b3db9 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.mdx index 9186958c5e3..346295e438d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 1baf15c259e..adb5476d741 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index 35084f76028..1b81ab42967 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.mdx index 812451b1863..17492950396 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.mdx index 6564e91e299..a079fdd57b8 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") as a list of [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")s, [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")s, and [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")s. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.mdx index 5f1cd3872b4..786bd099245 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.mdx index f7e611cffd0..5a9186c793e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.mdx index b38334d986a..d4d1da187c2 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.mdx index f166f01a6ae..cb50c757fda 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index 8995095630c..965561a7c60 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index a115ff6cd1b..50ccc04a2d7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.mdx index 5cf5f4dd07a..26b30f56bdb 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.mdx index 771a1c5679b..963d60ba2cc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map or target as ancilla on the layout. @@ -122,7 +122,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in `layout_qregs` already exist in `dag_qregs`. Otherwise, raise. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.mdx index f0f489167d2..27ad4442c6c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.mdx index 0dda57e0b31..9e7e39684ca 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.mdx index 4a48eab2423..ec05ead78a4 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects and unroll custom definitions. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.mdx index f09dd387477..103ade9e0c2 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.mdx index d283f79efe9..8986a0f0b20 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.mdx index 24796ce6c6c..60112740780 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.mdx index 05ccaed1cb9..abf545b427a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 12d807284f5..35a817261f1 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 0407aae89df..44a89932c98 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.mdx index c0ea9f337ef..d223a3cef52 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index e13571b39fc..e64b7304014 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.mdx index c5484c63926..73bdf26971e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint # MinimumPoint - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Check if the DAG has reached a relative semi-stable point over previous runs diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index c03945a1777..4fed9b3cd46 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.mdx index 351549787c6..16263cf9e31 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle # NormalizeRXAngle - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Normalize theta parameter of RXGate instruction. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.mdx index bd9d2394d83..1bee1006d0e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.mdx index 102eeedd235..29b805a271e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -43,7 +43,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -126,7 +126,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index dc8adcbf37e..830aea87180 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 0e8eaae7f37..ba97656fadd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and resynthesizing the results. The commutation rules are stored in `commutation_table`. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.mdx index bcfcbb792a8..60a70fcf59f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.mdx index 8b729beb3f2..23737ac07dc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index dbb0fd53c3d..e59937eb1b4 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.mdx index a1b2f8ef40d..94513a9bd1e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.mdx index 8a361dbda90..84acc73ea86 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder # RXCalibrationBuilder - + Bases: `CalibrationBuilder` Add single-pulse RX calibrations that are bootstrapped from the SX calibration. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index cd0b244a78f..8b9997116ce 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 7ea2290aaeb..ec4d7b72d4a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.mdx index d934cba94fc..6816dab6a45 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 83b31023a1f..ca016ef05c1 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index ab0675bce60..8c879413dbf 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 5d024cf8f6f..5c43092b293 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index cc1fc8c1a32..dea6f5c2641 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.mdx index 8b5baea481c..98f7de81ec3 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.mdx index 498ba2927a8..835907c9d56 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout # SabrePreLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a starting layout to use for additional Sabre layout trials. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.mdx index 9aa2f4d03de..fe2d446f189 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.mdx index 0f861bd1e67..42fce251a0e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.mdx index e045bbc869a..ad0ac46cfbd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.mdx index 8d7f8472dcc..40f53cfa6d4 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.mdx index e088c445841..8ce17c57618 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index 317e44fb3f5..f57a503685d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.mdx index 929c987e362..737d5bdfc6c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.mdx index 15bd3c933d0..3cb9407f594 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.mdx index 141809e06dc..bda56e7dfe7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index a829549f330..04c81b7f961 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.mdx index 974f5be3657..2c64f03274f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.mdx index 703731970a2..09af5e5e95d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.mdx index 7a12b64887c..de3cf7eaa96 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 33dc0be0996..c40f205ea93 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.mdx index d8327182066..a74d42e950c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops # UnrollForLoops - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.mdx index 041532471b9..cb707bbd784 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.mdx index ad5c19df49f..92cf5fa92dc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.mdx index 9909647e983..24e3ac984f6 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.mdx index 612002102ac..565fc988914 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.mdx index d778f44578b..1c7c74e860d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index dc778bf34d6..13d1cd277bd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 91d5a6ebc27..5a2da89099b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 6604473448e..31ad59df106 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract unitary synthesis plugin class @@ -176,7 +176,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 781739e554b..e8ae46ab439 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index c8bfadd26d6..530e2347634 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 99f68f5dfa1..eb45d5a6891 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.mdx index bc966e02a5d..09d410c9413 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC # AQC - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A generic implementation of the Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx index 4d1e1bc610a..de61b888cc0 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx index 68716b0af9a..082ca8662a6 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class that represents an approximate circuit. @@ -215,7 +215,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit ### build - + **Constructs this circuit out of the parameters(thetas). Parameter values must be set before** constructing the circuit. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx index 69ab8e8bae9..b1e7c11da43 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx index a5b9bb1df90..3c9a2edbcf8 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx index de582d5c319..4fd7785df70 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx index a4b56c138a0..b93b64755fd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx index 6b38a5edf97..d922fdbc737 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.mdx index ff9b58d5339..fa53d813478 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.mdx index e591653462e..f7bad81f8dd 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.mdx index 7232ca2a328..cf09a85190d 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.mdx index 37aa87ebddc..3e00ffea268 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.mdx index e8d1f28dcf8..32599ec9ecc 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.mdx index 6c3d021bac6..c245f487bb8 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.mdx index 183b3d8557b..fe551d36dca 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle # DefaultStyle - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.45/qpy.mdx b/docs/api/qiskit/0.45/qpy.mdx index 04d0664542a..aa063884511 100644 --- a/docs/api/qiskit/0.45/qpy.mdx +++ b/docs/api/qiskit/0.45/qpy.mdx @@ -154,7 +154,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski #### QpyError - + Errors raised by the qpy module. Set the error message. diff --git a/docs/api/qiskit/0.45/scheduler.mdx b/docs/api/qiskit/0.45/scheduler.mdx index bf68285e9fa..79673d7a5f8 100644 --- a/docs/api/qiskit/0.45/scheduler.mdx +++ b/docs/api/qiskit/0.45/scheduler.mdx @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.45/tools.mdx b/docs/api/qiskit/0.45/tools.mdx index 9fba3e357c4..661bdda0b45 100644 --- a/docs/api/qiskit/0.45/tools.mdx +++ b/docs/api/qiskit/0.45/tools.mdx @@ -151,7 +151,7 @@ A helper component for publishing and subscribing to events. #### TextProgressBar - + A simple text-based progress bar. **output\_handlerthe handler the progress bar should be written to, default** diff --git a/docs/api/qiskit/0.45/transpiler.mdx b/docs/api/qiskit/0.45/transpiler.mdx index 6b757ddd0cd..57b5b66bcb3 100644 --- a/docs/api/qiskit/0.45/transpiler.mdx +++ b/docs/api/qiskit/0.45/transpiler.mdx @@ -940,7 +940,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError - + Exceptions raised during transpilation. Set the error message. @@ -948,7 +948,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -956,7 +956,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError - + Base class for errors raised by the coupling graph object. Set the error message. @@ -964,7 +964,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError - + Errors raised by the layout object. Set the error message. diff --git a/docs/api/qiskit/0.45/utils.mdx b/docs/api/qiskit/0.45/utils.mdx index 2cf34c4b5d8..404b5f3a7e1 100644 --- a/docs/api/qiskit/0.45/utils.mdx +++ b/docs/api/qiskit/0.45/utils.mdx @@ -450,7 +450,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -490,7 +490,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -557,7 +557,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -571,7 +571,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.45/visualization.mdx b/docs/api/qiskit/0.45/visualization.mdx index 8d3cf0ebe1c..02742f0d4c3 100644 --- a/docs/api/qiskit/0.45/visualization.mdx +++ b/docs/api/qiskit/0.45/visualization.mdx @@ -235,7 +235,7 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/0.46/algorithms.mdx b/docs/api/qiskit/0.46/algorithms.mdx index ad95f845e01..7a86ae062c5 100644 --- a/docs/api/qiskit/0.46/algorithms.mdx +++ b/docs/api/qiskit/0.46/algorithms.mdx @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states. #### AlgorithmError - + For Algorithm specific errors. Set the error message. diff --git a/docs/api/qiskit/0.46/circuit.mdx b/docs/api/qiskit/0.46/circuit.mdx index b473c603027..227b694cb8b 100644 --- a/docs/api/qiskit/0.46/circuit.mdx +++ b/docs/api/qiskit/0.46/circuit.mdx @@ -345,7 +345,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c #### CircuitError - + Base class for errors raised while processing a circuit. Set the error message. diff --git a/docs/api/qiskit/0.46/circuit_classical.mdx b/docs/api/qiskit/0.46/circuit_classical.mdx index 38654af0ff9..01a0c9de962 100644 --- a/docs/api/qiskit/0.46/circuit_classical.mdx +++ b/docs/api/qiskit/0.46/circuit_classical.mdx @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr - + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap #### Var - + A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` #### Value - + A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary - + A unary expression. **Parameters** @@ -91,7 +91,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -114,7 +114,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary - + A binary expression. **Parameters** @@ -126,7 +126,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -209,7 +209,7 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast - + A cast from one type to another, implied by the use of an expression in a different context. @@ -590,7 +590,7 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor - + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. ##### visit\_binary @@ -735,7 +735,7 @@ All types inherit from an abstract base class: ### Type - + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -747,13 +747,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q ### Bool - + The Boolean type. This has exactly two values: `True` and `False`. ### Uint - + An unsigned integer of fixed bit width. @@ -796,7 +796,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. ### Ordering - + Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. diff --git a/docs/api/qiskit/0.46/circuit_singleton.mdx b/docs/api/qiskit/0.46/circuit_singleton.mdx index f57bd19385d..861a1b19b5f 100644 --- a/docs/api/qiskit/0.46/circuit_singleton.mdx +++ b/docs/api/qiskit/0.46/circuit_singleton.mdx @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonInstruction - + A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") which has an immutable definition and any instance of [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions. @@ -56,7 +56,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonGate - + A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -64,7 +64,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonControlledGate - + A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -126,7 +126,7 @@ Subclasses of [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstru #### \_singleton\_lookup\_key - + Given the arguments to the constructor, return a key tuple that identifies the singleton instance to retrieve, or `None` if the arguments imply that a mutable object must be created. For performance, as a special case, this method will not be called if the class constructor was given zero arguments (e.g. the construction `XGate()` will not call this method, but `XGate(label=None)` will), and the default singleton will immediately be returned. diff --git a/docs/api/qiskit/0.46/dagcircuit.mdx b/docs/api/qiskit/0.46/dagcircuit.mdx index 71a3212af26..b6a344a445b 100644 --- a/docs/api/qiskit/0.46/dagcircuit.mdx +++ b/docs/api/qiskit/0.46/dagcircuit.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -42,7 +42,7 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError - + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/0.46/exceptions.mdx b/docs/api/qiskit/0.46/exceptions.mdx index 6a648451936..4281cb04a56 100644 --- a/docs/api/qiskit/0.46/exceptions.mdx +++ b/docs/api/qiskit/0.46/exceptions.mdx @@ -22,7 +22,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: ### QiskitError - + Base class for errors raised by Qiskit. Set the error message. @@ -38,7 +38,7 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any @@ -48,7 +48,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError - + Raised when an error is encountered reading a user config file. Set the error message. @@ -56,7 +56,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError - + Raised when the file provided is not valid for the specific task. Set the error message. diff --git a/docs/api/qiskit/0.46/extensions.mdx b/docs/api/qiskit/0.46/extensions.mdx index 5812cee326b..f937a4e2a98 100644 --- a/docs/api/qiskit/0.46/extensions.mdx +++ b/docs/api/qiskit/0.46/extensions.mdx @@ -36,7 +36,7 @@ The additional gates in this module will tend to raise a custom exception when t ### ExtensionError - + Base class for errors raised by extensions module. Set the error message. diff --git a/docs/api/qiskit/0.46/opflow.mdx b/docs/api/qiskit/0.46/opflow.mdx index 3c6f831ff3a..7159e8ac28c 100644 --- a/docs/api/qiskit/0.46/opflow.mdx +++ b/docs/api/qiskit/0.46/opflow.mdx @@ -194,7 +194,7 @@ $$ ### OpflowError - + Deprecated: For Opflow specific errors. Set the error message. diff --git a/docs/api/qiskit/0.46/passmanager.mdx b/docs/api/qiskit/0.46/passmanager.mdx index 73ab2dffa5e..1f6b59723e9 100644 --- a/docs/api/qiskit/0.46/passmanager.mdx +++ b/docs/api/qiskit/0.46/passmanager.mdx @@ -163,7 +163,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza #### PassManagerError - + Pass manager error. Set the error message. diff --git a/docs/api/qiskit/0.46/providers.mdx b/docs/api/qiskit/0.46/providers.mdx index 8684cbfd8f7..b5eb1afd93a 100644 --- a/docs/api/qiskit/0.46/providers.mdx +++ b/docs/api/qiskit/0.46/providers.mdx @@ -77,7 +77,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. @@ -85,7 +85,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. @@ -93,7 +93,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobError - + Base class for errors raised by Jobs. Set the error message. @@ -101,7 +101,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. @@ -109,7 +109,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p #### BackendConfigurationError - + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/0.46/providers_fake_provider.mdx b/docs/api/qiskit/0.46/providers_fake_provider.mdx index eb71ff020e4..1e789284ab4 100644 --- a/docs/api/qiskit/0.46/providers_fake_provider.mdx +++ b/docs/api/qiskit/0.46/providers_fake_provider.mdx @@ -212,7 +212,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeBackendV2 - + A fake backend class for testing and noisy simulation using real backend snapshots. The class inherits [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class. This version differs from earlier [`FakeBackend`](#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.FakeBackend") (V1) class in a few aspects. Firstly, configuration attribute no longer exists. Instead, attributes exposing equivalent required immutable properties of the backend device are added. For example `fake_backend.configuration().n_qubits` is accessible from `fake_backend.num_qubits` now. Secondly, this version removes extra abstractions [`FakeQasmBackend`](#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.FakeQasmBackend") and [`FakePulseBackend`](#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.FakePulseBackend") that were present in V1. @@ -226,7 +226,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeBackend - + This is a dummy backend just for testing purposes. FakeBackend initializer. @@ -239,7 +239,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakeQasmBackend - + A fake OpenQASM backend. FakeBackend initializer. @@ -252,7 +252,7 @@ The fake backends based on IBM hardware are based on a set of base classes: ### FakePulseBackend - + A fake pulse backend. FakeBackend initializer. diff --git a/docs/api/qiskit/0.46/pulse.mdx b/docs/api/qiskit/0.46/pulse.mdx index 20620ea6cad..34dccc1003f 100644 --- a/docs/api/qiskit/0.46/pulse.mdx +++ b/docs/api/qiskit/0.46/pulse.mdx @@ -73,7 +73,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -620,7 +620,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -675,7 +675,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -2630,7 +2630,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. @@ -2638,7 +2638,7 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet - + Raised if the builder context does not have a backend. Set the error message. @@ -2646,7 +2646,7 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder - + Raised if no builder context is active. Set the error message. @@ -2654,7 +2654,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError - + Raised if instruction duration is unassigned. Set the error message. @@ -2662,7 +2662,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError - + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/0.46/qasm.mdx b/docs/api/qiskit/0.46/qasm.mdx index 6f306eef6a5..1a0a0ddd079 100644 --- a/docs/api/qiskit/0.46/qasm.mdx +++ b/docs/api/qiskit/0.46/qasm.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.qasm ### Qasm - + OPENQASM circuit object. Create an OPENQASM circuit object. @@ -36,19 +36,19 @@ python_api_name: qiskit.qasm ### OpenQASMLexer - + A pygments lexer for OpenQasm. ### QasmHTMLStyle - + A style for OpenQasm in a HTML env (e.g. Jupyter widget). ### QasmTerminalStyle - + A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.46/qasm2.mdx b/docs/api/qiskit/0.46/qasm2.mdx index a3029a93fcd..82305d7b560 100644 --- a/docs/api/qiskit/0.46/qasm2.mdx +++ b/docs/api/qiskit/0.46/qasm2.mdx @@ -85,7 +85,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -103,7 +103,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -164,7 +164,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error - + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -174,7 +174,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError - + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -184,7 +184,7 @@ When the exporters fail to export a circuit, likely because it has structure tha ### QASM2ExportError - + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/0.46/qasm3.mdx b/docs/api/qiskit/0.46/qasm3.mdx index d08dafd7a74..d49db76904b 100644 --- a/docs/api/qiskit/0.46/qasm3.mdx +++ b/docs/api/qiskit/0.46/qasm3.mdx @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -107,7 +107,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -119,7 +119,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -222,7 +222,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.mdx index dc83b922159..fd4d843a739 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob # AlgorithmJob - + Bases: `PrimitiveJob` This empty class is introduced for typing purposes. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.mdx index d2b3997b3f4..7eb78b0b37d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem # AmplificationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.mdx index 8db1a6d50b4..2f66a779842 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier # AmplitudeAmplifier - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The interface for amplification algorithms. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier ### amplify - + Run the amplification algorithm. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.mdx index 4d0d0906e84..59373549a40 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation # AmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -87,7 +87,7 @@ $$ ### compute\_confidence\_interval - + Compute the (1 - alpha) confidence interval. **Parameters** @@ -111,7 +111,7 @@ $$ ### compute\_mle - + Compute the Maximum Likelihood Estimator (MLE). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.mdx index 94654b53640..b155308dd2e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult # AmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.mdx index 0b15c3c0781..8e4979b3fdb 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator # AmplitudeEstimator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Amplitude Estimation interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator ### estimate - + Run the amplitude estimation algorithm. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.mdx index 32bc063f60e..aaf640236fe 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult # AmplitudeEstimatorResult - + Bases: `AlgorithmResult` The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.mdx index 0593b670cd9..229f25ce261 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### compute\_eigenvalues - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.mdx index abe2b5aeb30..027a9445604 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Deprecated: Eigensolver Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.mdx index 75f0c7a880b..67acd6bdc9f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EstimationProblem # EstimationProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.mdx index a8b18783671..04891d3ab36 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem # EvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Evolution problem class. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.mdx index 64ef540e7c3..787bb8ec033 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.EvolutionResult # EvolutionResult - + Bases: `AlgorithmResult` Deprecated: Class for holding evolution result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.mdx index 9f9c2e4cb06..d381d3885ed 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation # FasterAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx index 39a20f9d718..aea93fba894 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult # FasterAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.Grover.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.Grover.mdx index 553fabd1ae3..5ea8bf02a4f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.Grover.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.Grover # Grover - + Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") Grover’s Search algorithm. @@ -168,7 +168,7 @@ $$ ### optimal\_num\_iterations - + Return the optimal number of iterations, if the number of solutions is known. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.mdx index 0f4d20a8af2..d83bb313d45 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.GroverResult # GroverResult - + Bases: `AmplitudeAmplifierResult` Grover Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.mdx index 3b4fdb79bc0..33fe170a52c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation # HamiltonianPhaseEstimation - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx index 8ebd71fc79f..cdc0481deab 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult # HamiltonianPhaseEstimationResult - + Bases: `AlgorithmResult` Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.mdx index ad2f1d9326b..86627fb8570 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver # ImaginaryEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Imaginary Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.mdx index 49296a566cf..b3a70e6f628 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver # ImaginaryTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Imaginary Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver ### evolve - + Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.mdx index 6259c538024..6170922c052 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation # IterativeAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx index 143a9878568..908639efac4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult # IterativeAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.mdx index 9d6523ebfb4..6d66005502e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation # IterativePhaseEstimation - + Bases: `PhaseEstimator` Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx index dd65306d2af..4a708f29ea2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation # MaximumLikelihoodAmplitudeEstimation - + Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") The Maximum Likelihood Amplitude Estimation algorithm. @@ -70,7 +70,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation ### compute\_confidence\_interval - + Compute the alpha confidence interval using the method kind. The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx index 7a7cfe23891..29879775c77 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult # MaximumLikelihoodAmplitudeEstimationResult - + Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.mdx index ed7ef337ee5..a8fe3d1f7c4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Minimum Eigensolver Interface. @@ -25,7 +25,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### compute\_minimum\_eigenvalue - + 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. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.mdx index 9de663aead9..c50eaeda98c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Deprecated: Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.mdx index 9a77c66f721..155692c862f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: NumPy Eigensolver algorithm. @@ -67,7 +67,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.mdx index 8f55d0b7adc..e18276e6358 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Numpy Minimum Eigensolver algorithm. @@ -54,7 +54,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.mdx index 917df1a941c..ada0668d3be 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQD # PVQD - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") The projected Variational Quantum Dynamics (p-VQD) Algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.mdx index 1d1df90a6aa..056cfed5b07 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PVQDResult # PVQDResult - + Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") The result object for the p-VQD algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.mdx index dbcd9affbc6..63a9722a328 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation # PhaseEstimation - + Bases: `PhaseEstimator` Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.mdx index 800d48b02f6..835419ac1db 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult # PhaseEstimationResult - + Bases: `PhaseEstimatorResult` Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.mdx index 485ac503824..19a722f0ce9 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale # PhaseEstimationScale - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. @@ -41,7 +41,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale ### from\_pauli\_sum - + Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.mdx index 49f85a6950c..f1b7751a322 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.QAOA # QAOA - + Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") Deprecated: Quantum Approximate Optimization Algorithm. @@ -221,7 +221,7 @@ python_api_name: qiskit.algorithms.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.mdx index 9d6c6a8be12..5f8581dc58b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealEvolver # RealEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Interface for Quantum Real Time Evolution. @@ -23,7 +23,7 @@ python_api_name: qiskit.algorithms.RealEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.mdx index 57ffcb7a71b..8f95fe5e352 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver # RealTimeEvolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for Quantum Real Time Evolution. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver ### evolve - + Perform real time evolution $\exp(-i t H)|\Psi\rangle$. Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, as provided in the `evolution_problem`. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.mdx index 5bd6c292b79..4ba4380de7f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver # SciPyImaginaryEvolver - + Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Classical Evolver for imaginary time evolution. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.mdx index 6da912553f3..df4e35e301b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver # SciPyRealEvolver - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Classical Evolver for real time evolution. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.mdx index 6e128e3ecf8..4736e9afc44 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem # TimeEvolutionProblem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time evolution problem class. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.mdx index 8b8f31c44e9..04275cd03f4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult # TimeEvolutionResult - + Bases: `AlgorithmResult` Class for holding time evolution result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.mdx index ffe6a0155cf..d14b035146f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE # TrotterQRTE - + Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") Deprecated: Quantum Real Time Evolution using Trotterization. @@ -97,7 +97,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQD.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.VQD.mdx index 9f0e5b4c96d..f0d65725f76 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQD.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") Deprecated: Variational Quantum Deflation algorithm. @@ -214,7 +214,7 @@ python_api_name: qiskit.algorithms.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.mdx index a430bfda1c6..a7286077eb5 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQDResult # VQDResult - + Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") Deprecated: VQD Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.VQE.mdx index 9925eb7c35b..fe687c30cf7 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") Deprecated: Variational Quantum Eigensolver algorithm. @@ -239,7 +239,7 @@ python_api_name: qiskit.algorithms.VQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.mdx index ca3b301f771..fe7728f07b8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQITE # VarQITE - + Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") Variational Quantum Imaginary Time Evolution algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.mdx index 78ab65d8d11..fa6624a54b2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.VarQRTE # VarQRTE - + Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Variational Quantum Real Time Evolution algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.mdx index 79a86f31f86..5f113fe871d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver # Eigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### compute\_eigenvalues - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.mdx index b62e723cb59..53b3e6e9869 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult # EigensolverResult - + Bases: `AlgorithmResult` Eigensolver result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx index b90ef717267..44821afb9cc 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver # NumPyEigensolver - + Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The NumPy eigensolver algorithm. @@ -61,7 +61,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx index eb1ad7abcd0..40c46104059 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult # NumPyEigensolverResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") NumPy eigensolver result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.mdx index 71d4a7177fb..bc9680fc781 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD # VQD - + Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") The Variational Quantum Deflation algorithm. Implementation using primitives. @@ -138,7 +138,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.mdx index cc75996be55..39b024392bb 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult # VQDResult - + Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") VQD Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx index c1ff2775811..5c5756a45f6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient # BaseEstimatorGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for an `EstimatorGradient` to compute the gradients of the expectation value. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.mdx index 7a49f6f1a89..c2ea89c1777 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT # BaseQGT - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. QGT is defined as: diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.mdx index 2ebc8b204ca..a6e7ce53181 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient # BaseSamplerGradient - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a `SamplerGradient` to compute the gradients of the sampling probability. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.mdx index a4f105817d4..1711a4c5d80 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult # EstimatorGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of EstimatorGradient. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx index 965fccd88d2..078bc7640ac 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient # FiniteDiffEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by finite difference method \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx index c07150bd7e2..fe51f1f4cd5 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient # FiniteDiffSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by finite difference method \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx index 5aaae42fafd..9d5543d7097 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient # LinCombEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.mdx index da3e5d9df81..a44eb11257d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT # LinCombQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx index 3e2e2200aae..5a01033e45b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient # LinCombSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability. This method employs a linear combination of unitaries \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx index 00cde388e8d..0ea597eee05 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient # ParamShiftEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation values by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx index 8b350d43ecb..e2b42a96ddf 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient # ParamShiftSamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the parameter shift rule \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.mdx index ae792988341..5739899bbfc 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFI # QFI - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. QFI is defined as: diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.mdx index 5f1b8c56f58..820c1defc30 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult # QFIResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QFI. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.mdx index 8603598c08f..cec690c4ec8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult # QGTResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of QGT. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx index bba665e3578..76c04bc00f4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient # ReverseEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Estimator gradients with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.mdx index db8b6d7e864..ad163fad398 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT # ReverseQGT - + Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") QGT calculation with the classically efficient reverse mode. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx index 8f4d7999c5c..eb6339eb984 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient # SPSAEstimatorGradient - + Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.mdx index 946f0811616..906a37e8a77 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient # SPSASamplerGradient - + Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.mdx index 719e16ca190..77d63b55102 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult # SamplerGradientResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of SamplerGradient. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx index 7317f13b38f..2387fef87f8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE # AdaptVQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The Adaptive Variational Quantum Eigensolver algorithm. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx index fd0068b2eb7..c472c700ff0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult # AdaptVQEResult - + Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") AdaptVQE Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx index 1b3549fe26c..ddc5bac59df 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver # MinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The minimum eigensolver interface. @@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### compute\_minimum\_eigenvalue - + Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. **Parameters** @@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx index 457acb3cd58..36124b95557 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult # MinimumEigensolverResult - + Bases: `AlgorithmResult` Minimum eigensolver result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx index ee17ad541ff..0ea6ec8d391 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver # NumPyMinimumEigensolver - + Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The NumPy minimum eigensolver algorithm. @@ -48,7 +48,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx index 90f72d8f2e3..dcd1563796c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR # NumPyMinimumEigensolverResult - + Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") NumPy minimum eigensolver result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx index 363764d1e60..a25b2b0c423 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA # QAOA - + Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") The Quantum Approximate Optimization Algorithm (QAOA). @@ -149,7 +149,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx index 02070d64ac5..eb26a1dde38 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolver - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") The Sampling Minimum Eigensolver Interface. @@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### compute\_minimum\_eigenvalue - + Compute the minimum eigenvalue of a diagonal operator. **Parameters** @@ -36,7 +36,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx index 5a4f2a1f83a..a32a32ae61b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv # SamplingMinimumEigensolverResult - + Bases: `AlgorithmResult` Sampling Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx index 0df7c220e8f..9dda4b47276 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE # SamplingVQE - + Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. @@ -145,7 +145,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx index 8332b1c443d..a025b41e4d7 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult # SamplingVQEResult - + Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") VQE Result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.mdx index a2cc48a5223..09789e21631 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE # VQE - + Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") The variational quantum eigensolver (VQE) algorithm. @@ -149,7 +149,7 @@ $$ ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. If the minimum eigensolver computes an eigenvalue of the main `operator` then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx index b3698c4fd1f..bda5e7e6ae3 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult # VQEResult - + Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") Variational quantum eigensolver result. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.mdx index 1031825424f..c161c06569d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM # ADAM - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Adam and AMSGRAD optimizers. @@ -137,7 +137,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -242,7 +242,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.mdx index 8aaf05f366f..8685f29a7a9 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD # AQGD - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: @@ -139,7 +139,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -205,7 +205,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.mdx index d6c3034f401..1abaa68e501 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData # AskData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for return type of [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask"). diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.mdx index b119486c1cd..038acd95373 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA # BOBYQA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Bound Optimization BY Quadratic Approximation algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.mdx index c64ad033a68..e2f3999c8ab 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CG # CG - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Conjugate Gradient optimizer. @@ -122,7 +122,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.algorithms.optimizers.CG ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.mdx index 584293b5c95..886e7d6024c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA # COBYLA - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Constrained Optimization By Linear Approximation optimizer. @@ -120,7 +120,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.mdx index d7c0d82cb3d..8d40afd3723 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS # CRS - + Bases: `NLoptOptimizer` Controlled Random Search (CRS) with local mutation optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.mdx index b983f1f6bf6..2067adfa67c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L # DIRECT\_L - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx index 805b6c0b841..43211d5d13b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND # DIRECT\_L\_RAND - + Bases: `NLoptOptimizer` DIviding RECTangles Locally-biased Randomized optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.mdx index 2aab7d03c6c..afe19842804 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH # ESCH - + Bases: `NLoptOptimizer` ESCH evolutionary optimizer. @@ -131,7 +131,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.mdx index cd3e332d107..1d0968b30bb 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS # GSLS - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Gaussian-smoothed Line Search. @@ -158,7 +158,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.mdx index 99da958af26..7c12e007865 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent # GradientDescent - + Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") The gradient descent minimization routine. @@ -312,7 +312,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -416,7 +416,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.mdx index e90feae743c..1dc16c45319 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState # GradientDescentState - + Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") State of [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent"). diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.mdx index 87764bd4e40..317460059bd 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL # IMFIL - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") IMplicit FILtering algorithm. @@ -119,7 +119,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.mdx index f43c837ee5a..75d259f8192 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES # ISRES - + Bases: `NLoptOptimizer` Improved Stochastic Ranking Evolution Strategy optimizer. @@ -129,7 +129,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.mdx index 5a17450953f..af9e5b8ef4c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B # L\_BFGS\_B - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Limited-memory BFGS Bound optimizer. @@ -128,7 +128,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -194,7 +194,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.mdx index db4176b6cf5..b78c3653e80 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer # Minimizer - + Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") Callable Protocol for minimizer. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.mdx index a97405c6f7f..4101d3705a8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD # NELDER\_MEAD - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nelder-Mead optimizer. @@ -126,7 +126,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -192,7 +192,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx index d734af1173a..7456cdbb34a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT # NFT - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Nakanishi-Fujii-Todo algorithm. @@ -130,7 +130,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -196,7 +196,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.mdx index c60950b74bd..0f4d3b07714 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer # Optimizer - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for optimization algorithm. @@ -113,13 +113,13 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -140,7 +140,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### minimize - + Minimize the scalar function. **Parameters** @@ -185,7 +185,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.mdx index 00084183665..b1300899074 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult # OptimizerResult - + Bases: `AlgorithmResult` The result of an optimization routine. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.mdx index a25bdb5ef2d..c640d8da056 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState # OptimizerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base class representing the state of the optimizer. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx index b372a85d0e6..10ba771714a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel # OptimizerSupportLevel - + Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.mdx index fca0d47aad2..9c61c07fcd2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL # POWELL - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Powell optimizer. @@ -121,7 +121,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.mdx index 80ede5b3b9e..596c952aa33 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS # P\_BFGS - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Parallelized Limited-memory BFGS optimizer. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.mdx index 6fed40526e1..6403d10be7d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA # QNSPSA - + Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") The Quantum Natural SPSA (QN-SPSA) optimizer. @@ -187,7 +187,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -221,7 +221,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -231,7 +231,7 @@ $$ ### get\_fidelity - + Get a function to compute the fidelity of `circuit` with itself. @@ -278,7 +278,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -372,7 +372,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.mdx index 3da8722f8a2..1f98a7ac076 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP # SLSQP - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Sequential Least SQuares Programming optimizer. @@ -124,7 +124,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.mdx index 85d0ebdbc30..90042f35383 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT # SNOBFIT - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Stable Noisy Optimization by Branch and FIT algorithm. @@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.mdx index 903bcca8574..963747ab03a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA # SPSA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -213,7 +213,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA ### calibrate - + Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. The powerseries are: @@ -247,7 +247,7 @@ $$ ### estimate\_stddev - + Estimate the standard deviation of the loss function. **Return type** @@ -263,7 +263,7 @@ $$ ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -357,7 +357,7 @@ $$ ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.mdx index 2f30dd6e248..64694e82e9f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer # SciPyOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") A general Qiskit Optimizer wrapping scipy.optimize.minimize. @@ -116,7 +116,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -182,7 +182,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.mdx index 0acd4231da8..0f3d2ae6e0b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer # SteppableOptimizer - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Base class for a steppable optimizer. @@ -202,7 +202,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### create\_result - + Returns the result of the optimization. All the information needed to create such a result should be stored in the optimizer state and will typically contain the best point found, the function value and gradient at that point, the number of function and gradient evaluation and the number of iterations in the optimization. @@ -218,7 +218,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### evaluate - + Evaluates the function according to the instructions contained in `ask_data`. If the user decides to use [`step()`](#qiskit.algorithms.optimizers.SteppableOptimizer.step "qiskit.algorithms.optimizers.SteppableOptimizer.step") instead of [`ask()`](#qiskit.algorithms.optimizers.SteppableOptimizer.ask "qiskit.algorithms.optimizers.SteppableOptimizer.ask") and [`tell()`](#qiskit.algorithms.optimizers.SteppableOptimizer.tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell") this function will contain the logic on how to evaluate the function. @@ -238,13 +238,13 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### get\_support\_level - + Return support level dictionary ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -312,7 +312,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### start - + Populates the state of the optimizer with the data provided and sets all the counters to 0. **Parameters** @@ -346,7 +346,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.mdx index 386b497e68d..ea32b4e38b0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC # TNC - + Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") Truncated Newton (TNC) optimizer. @@ -125,7 +125,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -191,7 +191,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.mdx index 7aa07c4defd..8984545da6c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData # TellData - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.mdx index 4436281dd02..725e9b25a1e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA # UMDA - + Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") Continuous Univariate Marginal Distribution Algorithm (UMDA). @@ -201,7 +201,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### gradient\_num\_diff - + We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA ### wrap\_function - + Wrap the function to implicitly inject the args at the call of the function. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx index 8b17ff7bb97..9499511000b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate # LearningRate - + Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") Represents a Learning Rate. Will be an attribute of [`GradientDescentState`](qiskit.algorithms.optimizers.GradientDescentState "qiskit.algorithms.optimizers.GradientDescentState"). Note that [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps `Generator` so that we can also access the last yielded value. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx index da9cc3d7b31..580ae86fa91 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity # BaseStateFidelity - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap: @@ -23,7 +23,7 @@ $$ ### create\_fidelity\_circuit - + Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx index 54a624615aa..89203c0dafe 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute # ComputeUncompute - + Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") 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). The fidelity can be defined as the state overlap. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx index 22578fed8b5..d57e361e4d8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult # StateFidelityResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This class stores the result of StateFidelity computations. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx index d5e5b11c408..5b768f4f33d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE # TrotterQRTE - + Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") Quantum Real Time Evolution using Trotterization. Type of Trotterization is defined by a `ProductFormula` provided. @@ -88,7 +88,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE ### supports\_aux\_operators - + Whether computing the expectation value of auxiliary operators is supported. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx index 7843d2a272e..cbc51d9c880 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver # ForwardEulerSolver - + Bases: `OdeSolver` Forward Euler ODE solver. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx index 95d160f6a1a..5f41ff74c2d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP # ImaginaryMcLachlanPrinciple - + Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Wick-rotated Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx index 965765ef6f9..27796be1596 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa # ImaginaryVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for an Imaginary Variational Principle. The imaginary variant means that we consider imaginary time dynamics. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx index 685cce0a850..e612be460c0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci # RealMcLachlanPrinciple - + Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") Class for a Real McLachlan’s Variational Principle. It aims to minimize the distance between both sides of the Schrödinger equation with a quantum state given as a parametrized trial state. The principle leads to a system of linear equations handled by a linear solver. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx index 91b49b9ecfb..74f999e4ca0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin # RealVariationalPrinciple - + Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class for a Real Variational Principle. The real variant means that we consider real time dynamics. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx index a7a76125d22..bede041e4ae 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl # VariationalPrinciple - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A Variational Principle class. It determines the time propagation of parameters in a quantum state provided as a parametrized quantum circuit (ansatz). @@ -42,7 +42,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl ### evolution\_gradient - + Calculates an evolution gradient according to the rules of this variational principle. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.mdx index 19f38678584..677a178dbb1 100644 --- a/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") Class for Run Configuration. @@ -67,7 +67,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.mdx b/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.mdx index 4bdf79d5e78..d2fec142bc3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit # AncillaQubit - + Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.mdx b/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.mdx index 669e90b5240..7e50750874a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister # AncillaRegister - + Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.mdx index c5cae14eaa4..ecc200342c2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation # AnnotatedOperation - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Annotated operation. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Bit.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Bit.mdx index 5376b4f195c..19f27f42964 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Bit.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Bit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Bit # Bit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic bit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.mdx index 5656b211361..7bbac619f32 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.mdx index 8b0f5ce7825..4150c927c6a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.mdx index ca35d368357..7bea33623f4 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister # ClassicalRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Clbit.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Clbit.mdx index b08c9d2cb64..aed7434b28a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Clbit.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Clbit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit # Clbit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a classical bit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.mdx index cc865e296c5..a3938d3c69e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CommutationChecker # CommutationChecker - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") This code is essentially copy-pasted from commutative\_analysis.py. This code cleverly hashes commutativity and non-commutativity results between DAG nodes and seems quite efficient for large Clifford circuits. They may be other possible efficiency improvements: using rule-based commutativity analysis, evicting from the cache less useful entries, etc. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.mdx index 8a883187a25..31c69d573b1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.mdx index e74da9a8539..a296ef08bbb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class to encapsulate all control flow operations. @@ -258,7 +258,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.mdx index 517f9da20d0..a0919615ea5 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlModifier # ControlModifier - + Bases: `Modifier` Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.mdx index a54207f8dd5..ca6d3d1c57b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Delay.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Delay.mdx index e2d30b39563..9db6eed33df 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Delay.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay # Delay - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.mdx index c3cf9a05fe2..dee30ebdd45 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.mdx index 201dc9db5a4..759b40a5898 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Gate.mdx index 521a9358d2c..03d3ac0a0e2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.mdx index 448cff39c41..efd5b841dac 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Instruction.mdx index 2b1f3de9452..587d03629a2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.mdx index acd20ad7466..677a3670951 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.mdx index b6e256c573a..dc5dbd9ad7b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InverseModifier # InverseModifier - + Bases: `Modifier` Inverse modifier: specifies that the operation is inverted. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Operation.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Operation.mdx index dcaea417236..80810d5511f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Parameter.mdx index 8fa471ac64d..f9346ca6c1b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.mdx index d581d6e776d..7a966ef48ed 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.mdx index 032ec7e96d5..b7c7a1580f5 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.mdx index 1a244b8ade5..65e78854914 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.PowerModifier # PowerModifier - + Bases: `Modifier` Power modifier: specifies that the operation is raised to the power `power`. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.mdx index d548ef8ef92..aca924ba1b3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Create a new circuit. @@ -482,7 +482,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -588,7 +588,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -598,7 +598,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1407,7 +1407,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1430,7 +1430,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -1452,7 +1452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.mdx index b51f6a8479e..4219fc41704 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister # QuantumRegister - + Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Qubit.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Qubit.mdx index 1d3bf4e98b7..df6206a48fd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Qubit.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Qubit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit # Qubit - + Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a quantum bit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Register.mdx b/docs/api/qiskit/0.46/qiskit.circuit.Register.mdx index 10a455593e7..b547cd00b13 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Register.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.Register.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Register # Register - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Implement a generic register. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.mdx index 9c2967e3a5c..b03ce0bfb5c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp # SwitchCaseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") can be used to represent a default condition. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.mdx index 4576709e4d2..893950ce2d6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 16fea803ead..6e55bc16a6c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `ClassicalElement` The Boolean Expression gate. @@ -237,7 +237,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index ee05b7ab6de..22f7af4fa23 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `ClassicalElement` Represent a classical function and its logic network. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 26fb7f3b1ae..159601e07cb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 74b7e2da667..c7c673557e0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.AND.mdx index be0ef1af490..9fb8261e45f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.mdx index 53852f1a5ab..19d5d758ffa 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier # Barrier - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Barrier instruction. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.mdx index 396717ee163..fd529ffefa8 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.mdx index 93c29b6e207..189cd65230f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.mdx index 12795a35ddb..771d16d3608 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.mdx index cc73ac9a793..f0fc0501828 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.mdx index 0563614ae85..4f907eaedaf 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCZ gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 3e764cb763e..f07e55cb28f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.mdx index ee5596a1ee7..b1cad9bdb81 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.mdx index 8cb11b45a00..4fcf4bb7dfe 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.mdx index 4f09f7b9529..39ac97ad9e4 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.mdx index 6747f4c219f..ea59d349dd2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.mdx index cad78e710de..e4eacf9febb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.mdx index 483e3b26b00..589fd719e8d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.mdx index cec8fb6ea31..283bc9a11c6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.mdx index a91e1a7f529..66022a4e5d6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.mdx index cb17ea260c7..6145a854244 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.mdx index fba3e9bd7e8..12d6d62dab0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.mdx index 58e00bf0228..e8db2ac1c43 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.mdx index fadd40d71f0..38929ef9d24 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.mdx index 1738c7c6a7e..2436c03c49d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.mdx index fa9896412d1..f35748d1157 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.mdx index 8fc91ddb849..a7febb973de 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.mdx index b50f30f5fac..eb1dcae234c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Double-CNOT gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.mdx index b4acfe42444..809043b0b60 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.mdx index e28f4655bdc..a15cbd46b61 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate # DiagonalGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Gate implementing a diagonal transformation. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.mdx index e551e1bad06..68c2c72fca0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.mdx index 81e332708f9..5e4e060f040 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.mdx index ece55a9314e..54cee57174d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 8e0f425d66d..ff4c1758493 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.mdx index b9b7d33ce34..9390fd477f9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.mdx index 99d72e07d8e..1e2814831c3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.mdx index c6041d0d5a2..f538b981a57 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.mdx index e8d5a25db6a..f85fccb5927 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.mdx index 784ba20b8d9..fa0dd47c48e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GR.mdx index 705dec4b1c7..47a98d130d1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.mdx index 0b8cbd83d37..8e072eb67d1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.mdx index aff8991cb27..1c1ea1cf37b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.mdx index 43bd1b51b24..ca8a890a173 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.mdx index 4db3d0c9099..98492eab115 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate # GlobalPhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The global phase gate ($e^{i\theta}$). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.mdx index 2e4c25789a5..b2d901b6575 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.mdx index b788bdf01fc..58d79c8bd51 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.mdx index 932be4ea6e2..a5ec4f49bfe 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index b6dff545625..af622cdb81a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.mdx index 9324134afd3..305074cf9fd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate # HamiltonianGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hamiltonian operator as a gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.mdx index 3b879218552..d6e9b22e41b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.mdx index ca729fff504..fa940cf9680 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Identity gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.mdx index f779cc62b7d..ed549890287 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.mdx index 5d61d24041d..b33a6632e76 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Initialize # Initialize - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.mdx index 0fed50f5e4f..c8c1db12733 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.mdx index 47097c79ebe..205b27470bb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.mdx index c68ad25156c..f042e4fa545 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Isometry # Isometry - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Decomposition of arbitrary isometries from $m$ to $n$ qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 128b29868c4..d23bf220058 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.mdx index 5f8559b67cd..3450ca8bda6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.mdx index 7c6af7395b0..8ff84c509a8 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.mdx index 450852d87a6..8c00d8aca31 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.mdx index 2989f39d4e4..a5ea96c021f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.mdx index a0caf1b3261..9d2ec24cfc9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.mdx index dd3ef2ef40a..44a80a06604 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.mdx index e07c1f71a69..0c619467c1b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.mdx index bfba5c83120..bb7be7bd7d6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.mdx index 300a21d4097..878d955a918 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.mdx index 9faa74d58ba..ac2a0cdb4b3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.mdx index ddaf2f95ee2..25d12226666 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Measure # Measure - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.mdx index 80ad628bcca..1fcc193ee22 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.OR.mdx index 442b4230d7d..5e075968cc0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.mdx index 8146b88673d..e056413c8fe 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.mdx index 9127f459031..767d697173b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.mdx index 44f1f3b6fdf..8df4d674bab 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.mdx index e65be69fb68..fec3aa8091b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.mdx index ab611f89a21..8478e08e80a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.mdx index b0752941f5b..056d11a1d23 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.mdx index ef19d3c4728..7760061d810 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.mdx index dbf61da6814..73a9a6accd7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.mdx index bc71766ff27..215a1a70dc2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -232,7 +232,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.mdx index 61b7c1dae0a..2561377cb3c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index afe1caf1c5d..49d12258b42 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index a188e78174c..d6d8aaad40a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.mdx index a61916f6442..6b06885e91e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.mdx index 98dc756e05d..a47a059f337 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.mdx index 813fdb7d059..a3b0c80b4a3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.mdx index 5cc15c65c44..5ae2ae73579 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -239,7 +239,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.mdx index 08e081ee7c2..b130c6d8866 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.mdx index e54de21b329..1c76c9e4ac7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.mdx index b7adae3a4a9..0c861ac530c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.mdx index 667cbe24bc8..d77da42fc64 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.mdx index d542c09c84e..f3577d12a00 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.mdx index 17047b32468..b621079f044 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.mdx index 53c8e3b4608..a506a69692f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.mdx index 94b2bf97186..f8572017c44 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.mdx index 6ffe77096df..525089ee38c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.mdx index b6e8f90a028..0d6a5d4f71b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.mdx index c6833ded7a0..687c94b90e2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.mdx index 089159e3240..ee8b2914313 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.mdx index ccd56569213..29419a2a836 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.mdx index ab9287ab394..0f3d6751a99 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.mdx index c22adb5491e..3c33f216eea 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Reset # Reset - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Qubit reset. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.mdx index 75ef9d4fec3..04e3fdd55da 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.mdx index b427f95d2d3..1ebbddf5408 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.mdx index cb29d922294..908ae429857 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.mdx index 06cfe5aff62..c4f39f04b41 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.mdx index ea4e53494b4..1c7ebefc25f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.mdx index 582b8ebb186..faf4fd7231a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The SWAP gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.mdx index b095244f7cb..8d7b49c6758 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.mdx index f38524c6beb..9ce625ef3e1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.mdx index 906d514a61b..38689826a46 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.mdx index 38aa63d7b4e..3dca45a7d37 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.mdx index c23c581aafe..86345ff8828 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.mdx index 195a699a624..f3600ef956a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.mdx index aa257587e90..ba9448c5bdb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCGate # UCGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled gate (also called multiplexed gate). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.mdx index 4edb2b7eb8e..c287719dfd0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate # UCPauliRotGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled Pauli rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.mdx index f3138614063..b1032f21860 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRXGate # UCRXGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-X rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.mdx index 1c9b0f986ba..9e620e2300c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRYGate # UCRYGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Y rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.mdx index e39de3db364..fccc63dceba 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRZGate # UCRZGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Z rotations. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.mdx index 3b4fb7c20f5..031a86c60b2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.mdx index 5363fa5768c..c2229907c22 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.mdx index 17cbb9651a6..1fb550e43d1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap # UnitaryOverlap - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.mdx index 6dc2b448645..09f449b1d9c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.mdx index 43c8926149e..8e189c3b157 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.mdx index 88b7f4d8bb2..193aeb87406 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.mdx index cc64211adaa..1cc17ded55b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.mdx index 41e57a9d8a9..79c365c3a9a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.mdx index d26b4a23544..dd3caf6597f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.mdx index 1806222c35c..c550060850d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.mdx index 49797439ab8..1549cdecf95 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.mdx index ce8147a2f67..d04ed415ea1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.mdx index 5231024f932..c080d09592b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.mdx index 2dc7d1ee696..b99407d3e4a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") iSWAP gate. diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.mdx index 2502c27896c..06eccaa1845 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.mdx index a304e2065a2..cbd9680687c 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent the information at a node in the DAGDependency(). @@ -91,7 +91,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.mdx index ef08d6fe12f..b69dec7dd1d 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.mdx index a1de136c184..242f6bd5f6a 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.mdx index 553eb31d779..394bb62437d 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.mdx index d2d954bcb79..21df4702fd4 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -43,7 +43,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.mdx index 8dd74fb0e80..4af86f1546b 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.mdx b/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.mdx index 6ac2dbef055..296632493c7 100644 --- a/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.mdx +++ b/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary # SingleQubitUnitary - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit unitary. diff --git a/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.mdx b/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.mdx index aea2fc97411..ff0e8a0020b 100644 --- a/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.mdx +++ b/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.extensions.Snapshot # Snapshot - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.mdx index d17b8c73cde..36e8bee0770 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.OperatorBase # OperatorBase - + Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -63,7 +63,7 @@ python_api_name: qiskit.opflow.OperatorBase ### add - + Return Operator addition of self and other, overloaded by `+`. **Parameters** @@ -81,7 +81,7 @@ python_api_name: qiskit.opflow.OperatorBase ### adjoint - + Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. **Returns** @@ -95,7 +95,7 @@ python_api_name: qiskit.opflow.OperatorBase ### assign\_parameters - + 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. **Parameters** @@ -123,7 +123,7 @@ python_api_name: qiskit.opflow.OperatorBase ### compose - + Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like @@ -159,7 +159,7 @@ python_api_name: qiskit.opflow.OperatorBase ### equals - + 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. **Parameters** @@ -177,7 +177,7 @@ python_api_name: qiskit.opflow.OperatorBase ### eval - + 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). If `front` is None, the matrix-representation of the operator is returned. @@ -209,7 +209,7 @@ python_api_name: qiskit.opflow.OperatorBase ### mul - + 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`). **Parameters** @@ -241,7 +241,7 @@ python_api_name: qiskit.opflow.OperatorBase ### permute - + Permutes the qubits of the operator. **Parameters** @@ -263,7 +263,7 @@ python_api_name: qiskit.opflow.OperatorBase ### primitive\_strings - + 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. **Returns** @@ -277,7 +277,7 @@ python_api_name: qiskit.opflow.OperatorBase ### reduce - + 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. **Returns** @@ -287,7 +287,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensor - + 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 > -\[Y]- -\[X]- @@ -309,7 +309,7 @@ python_api_name: qiskit.opflow.OperatorBase ### tensorpower - + Return tensor product with self multiple times, overloaded by `^`. **Parameters** @@ -327,7 +327,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_circuit\_op - + Returns a `CircuitOp` equivalent to this Operator. **Return type** @@ -337,7 +337,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix - + 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. **Returns** @@ -351,7 +351,7 @@ python_api_name: qiskit.opflow.OperatorBase ### to\_matrix\_op - + Returns a `MatrixOp` equivalent to this Operator. **Return type** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.mdx index 838ca9e8539..0798196f2ec 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper # AbelianGrouper - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums. @@ -45,7 +45,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper ### group\_subops - + Given a ListOp, attempt to group into Abelian ListOps of the same type. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.mdx index 757a3bc90dc..d63e2cb58ef 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler # CircuitSampler - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.mdx index cbabaf51f9d..528c8656e87 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase # ConverterBase - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` 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` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` 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). @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase ### convert - + Accept the Operator and return the converted Operator **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.mdx index c04a3890b42..99ecff5c6ea 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum # DictToCircuitSum - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.mdx index 7e734aa7bab..ccbcbeab25e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange # PauliBasisChange - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -169,7 +169,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### measurement\_replacement\_fn - + A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### operator\_replacement\_fn - + A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. **Parameters** @@ -226,7 +226,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange ### statefn\_replacement\_fn - + A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.mdx b/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.mdx index 5f6dd862a32..b2cb4cb7076 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction # TwoQubitReduction - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.mdx index b5446f441f6..78e9f059003 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase # EvolutionBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Deprecated: A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `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. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase ### convert - + Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. > **Args:** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.mdx index f3a36fbfacd..7b602868381 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory # EvolutionFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory ### build - + 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.46/qiskit.opflow.evolutions.EvolvedOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.mdx index 8f2939a158e..a3ca89930c0 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp # EvolvedOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.mdx index cbeae072075..048a60d6ca0 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution # MatrixEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx index 48b3777a689..4feeed9592a 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution # PauliTrotterEvolution - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.mdx index 10ce97999d1..e2e41fa93c9 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift # QDrift - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.mdx index 661ef9098ea..98e2bd43eab 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki # Suzuki - + Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.mdx index bc01d841f21..eace20218a9 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter # Trotter - + Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") Deprecated: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.mdx index bae647495f1..d9ac109c04d 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase # TrotterizationBase - + Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") Deprecated: A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -29,7 +29,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase ### convert - + Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.mdx b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.mdx index 78a55b5e1e4..47b63f5193c 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory # TrotterizationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: A factory for conveniently creating TrotterizationBase instances. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory ### build - + A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.mdx index 762ac744c26..dbe29bbc672 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation # AerPauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.mdx index 72a3a82f600..0797e30d5df 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation # CVaRExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.mdx index 8541ff97d44..42f48a0a035 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase # ExpectationBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: A base for Expectation value converters. 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 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` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -21,7 +21,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### compute\_variance - + Compute the variance of the expectation estimator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase ### convert - + Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.mdx index 37e41802191..fe6df557ae4 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory # ExpectationFactory - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -17,7 +17,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory ### build - + 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.46/qiskit.opflow.expectations.MatrixExpectation.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.mdx index 1c3be747d84..13437a03f64 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation # MatrixExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.mdx b/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.mdx index b935d5f643e..2c764ba5b48 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation # PauliExpectation - + Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.mdx index ec6866d3dbc..daf924321c3 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient # CircuitGradient - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to gradient operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient of diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.mdx index 7cc0c0821f1..de8957fa787 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI # CircuitQFI - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Circuit to Quantum Fisher Information operator converter. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.mdx index 5f13007e0f4..cc82ed61493 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase # DerivativeBase - + Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") Deprecated: Base class for differentiating opflow objects. @@ -27,7 +27,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### convert - + **Parameters** * **operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The operator we are taking the gradient, Hessian or QFI of @@ -70,7 +70,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase ### parameter\_expression\_grad - + Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.mdx index ca4eaefd34c..35ce6785a4a 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Gradient # Gradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.mdx index 6713e83326e..9881676e6f2 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase # GradientBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.mdx index d7e612eddc6..71683e118cd 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.Hessian # Hessian - + Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") Deprecated: Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.mdx index 55007b47011..f98183937e3 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase # HessianBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.mdx index effdb2ec9c4..b8f73ec70b7 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient # NaturalGradient - + Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") Deprecated: Convert an operator expression to the first-order gradient. @@ -89,7 +89,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient ### nat\_grad\_combo\_fn - + Natural Gradient Function Implementation. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.mdx index 2768e9e512c..5e37e53c4f2 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFI # QFI - + Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") Deprecated: Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.mdx b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.mdx index 4d7b63f11ba..de24714440e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase # QFIBase - + Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") Deprecated: Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.mdx index 269e2660767..d212dcc3e84 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp # ComposedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.mdx index 1492acaa99c..d487edac0c8 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp # ListOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. @@ -200,7 +200,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp ### default\_combo\_fn - + ListOp default combo function i.e. lambda x: x **Return type** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.mdx index 94b7a40d37f..7dfd169691b 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp # SummedOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.mdx index 441feaeaf15..3ecf8bba867 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp # TensoredOp - + Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") Deprecated: A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.mdx index 6d9bbbcd385..c5fb884dd89 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp # CircuitOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.mdx index db40555ff99..c4f9bba3379 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp # MatrixOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.mdx index 387a0553645..68a5c41b5bf 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp # PauliOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.mdx index b4d0dddce39..4326e905f68 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp # PauliSumOp - + Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") Deprecated: Class for Operators backed by Terra’s `SparsePauliOp` class. @@ -199,7 +199,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp ### from\_list - + Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.mdx index 6a1450506e0..e9763780126 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp # PrimitiveOp - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx index e1c8c8285de..7d56b072cfe 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp # TaperedPauliSumOp - + Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") Deprecated: Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.mdx b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.mdx index 0d13d7401dd..1b7fe0b0881 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Z2 Symmetries @@ -131,7 +131,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries ### find\_Z2\_symmetries - + Finds Z2 Pauli-type symmetries of an Operator. **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.mdx index dcc1e94f68b..68f4831f5c6 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement # CVaRMeasurement - + Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") **Deprecated: A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.mdx index 79e95da6852..54dc5d3ea99 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn # CircuitStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -170,7 +170,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_dict - + Construct the CircuitStateFn from a dict mapping strings to probability densities. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn ### from\_vector - + Construct the CircuitStateFn from a vector representing the statevector. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.mdx index 4bdddf16045..0b430f17d3c 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn # DictStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.mdx index 6d61e263911..0ff75416a6f 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn # OperatorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.mdx index 1a544b21ce1..89008bfca7e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn # SparseVectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.mdx index 67b67f363f0..02f3219b165 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn # StateFn - + Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") Deprecated: A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.mdx b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.mdx index 2389a581f09..828ea5dd862 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.mdx +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn # VectorStateFn - + Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.mdx index 3661740a5df..b351bfd42f5 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BaseController # BaseController - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of controller. @@ -45,7 +45,7 @@ python_api_name: qiskit.passmanager.BaseController ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.mdx index 4252089d45e..0501abde8e6 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BasePassManager # BasePassManager - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Pass manager base class. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.mdx index 22e438c11b5..c3c30edf55c 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.ConditionalController # ConditionalController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A flow controller runs the pipeline once if the condition is true, or does nothing if the condition is false. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.mdx index 2b342ec2821..83ec60538f5 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.DoWhileController # DoWhileController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") Run the given tasks in a loop until the `do_while` condition on the property set becomes `False`. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.mdx index 8c30b60351c..c1ece2719cd 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.FlowController # FlowController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A legacy factory for other flow controllers. @@ -55,7 +55,7 @@ python_api_name: qiskit.passmanager.FlowController ### add\_flow\_controller - + Adds a flow controller. @@ -70,7 +70,7 @@ python_api_name: qiskit.passmanager.FlowController ### controller\_factory - + Create a new flow controller with normalization. @@ -110,7 +110,7 @@ python_api_name: qiskit.passmanager.FlowController ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. @@ -131,7 +131,7 @@ python_api_name: qiskit.passmanager.FlowController ### remove\_flow\_controller - + Removes a flow controller. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.mdx index cf2ddcdce4e..6a76e89db60 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear # FlowControllerLinear - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A standard flow controller that runs tasks one after the other. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.mdx index 92ec9d01915..0f212a82d4d 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.GenericPass # GenericPass - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of a single pass manager task. @@ -49,7 +49,7 @@ python_api_name: qiskit.passmanager.GenericPass ### run - + Run optimization task. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.mdx index 5df6350b2bb..0f720c0e17f 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PassManagerState # PassManagerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A portable container object that pass manager tasks communicate through generator. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.mdx index 48cab300a5a..3948a153cc0 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PropertySet # PropertySet - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A default dictionary-like object. diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.mdx index 81eb2280307..e9626eb705e 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus # WorkflowStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Collection of compilation status of workflow, i.e. pass manager run. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.mdx index ccfd06993ee..2a3e7218455 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.mdx index 4247d4ac3eb..f8f625a4494 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.mdx index 8551d7536bb..5afd6128fbe 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Estimator base class. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.mdx index 832d6fab4ea..9190a0ecaff 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Sampler base class diff --git a/docs/api/qiskit/0.46/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/0.46/qiskit.primitives.Estimator.mdx index 95850edaf17..468d7ef319e 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.mdx index 29df0a3b38a..4cf3f756bda 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `_BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/0.46/qiskit.primitives.Sampler.mdx index 9fae97d6109..725f9723df6 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] Sampler class. diff --git a/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.mdx index f05708505c0..3a77cf4b152 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `_BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/0.46/qiskit.providers.Backend.mdx b/docs/api/qiskit/0.46/qiskit.providers.Backend.mdx index c3de4a3324d..c7c79599897 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/0.46/qiskit.providers.BackendV1.mdx index d733dddcc75..35012ab2dc8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -21,7 +21,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.BackendV1 In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -141,7 +141,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.BackendV2.mdx index 5a2c9f5b404..da618bdb78a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -25,7 +25,7 @@ python_api_name: qiskit.providers.BackendV2 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -324,7 +324,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.mdx index c105665f02b..3abe687e628 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/0.46/qiskit.providers.Job.mdx b/docs/api/qiskit/0.46/qiskit.providers.Job.mdx index c919fcd1163..e4bbc73093c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.46/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.46/qiskit.providers.JobStatus.mdx index 1df03bfc265..714dfea5e19 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.46/qiskit.providers.JobV1.mdx b/docs/api/qiskit/0.46/qiskit.providers.JobV1.mdx index 453d73d9c0e..fc014368349 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class to handle jobs @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. @@ -105,13 +105,13 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.46/qiskit.providers.Options.mdx b/docs/api/qiskit/0.46/qiskit.providers.Options.mdx index 6d9b2e2f91b..0e27b74ddcf 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") Base options object diff --git a/docs/api/qiskit/0.46/qiskit.providers.Provider.mdx b/docs/api/qiskit/0.46/qiskit.providers.Provider.mdx index c0c5c4ed28c..39f33a6939d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.mdx index f0544a7586d..9b0e00060db 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a Backend Provider. @@ -23,7 +23,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.mdx index 0f375c27498..050bfb6260a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.mdx index b770282c7e5..e59998bb96f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider # BasicProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for test simulators. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.mdx b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.mdx index bb01f2930a9..65b188fd4c8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError # qiskit.providers.basic\_provider.BasicProviderError - + Base class for errors raised by the Basic Provider. Set the error message. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.mdx b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.mdx index 47bdcaae94a..25f9e245568 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob # BasicProviderJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicProviderJob class. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.mdx index eccc99964e0..178f450c0bf 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator # BasicSimulator - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Python implementation of a basic (non-efficient) quantum simulator. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.mdx index 988f7a1ae25..bc8f9b39863 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError # qiskit.providers.basicaer.BasicAerError - + Base class for errors raised by Basic Aer. Set the error message. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.mdx index 638c276e7c0..40268937297 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob # BasicAerJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicAerJob class. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.mdx index d99d337438c..ed750adf633 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider # BasicAerProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.mdx index 73be8bc5b3a..142ec6e8836 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy # QasmSimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of an OpenQASM 2 simulator. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx index e97076f4185..d5d14101c71 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy # StatevectorSimulatorPy - + Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") Python statevector simulator. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.mdx b/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.mdx index 4a2716a2e71..a118781a7ee 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy # UnitarySimulatorPy - + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx index 289505a9c37..8283988eefa 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend # ConfigurableFakeBackend - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") Configurable backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.mdx index 26b3716e1da..101c0db68b2 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 1Q backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.mdx index e4f7db4441a..bdbade5a02a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden # FakeAlmaden - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Almaden backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.mdx index b36d263e0cc..484e74e06bb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Almaden V2 backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.mdx index 475ece2ecfc..3c7d14a5bc4 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk # FakeArmonk - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.mdx index 72abd79a8ad..6e8919ae8c7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 1 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.mdx index 3adf30df92a..7d4be1e7799 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens # FakeAthens - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.mdx index be1fce496a4..b8c617360f8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 # FakeAthensV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.mdx index 08c0c841abf..c17cbb4156d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland # FakeAuckland - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.mdx index 765f1b3c0f0..b91b9cb08f7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 # FakeBackend5QV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.mdx index 91e831c716d..5479a29e8e5 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 # FakeBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A mock backend that doesn’t implement run() to test compatibility with Terra internals. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.mdx index 46c9c4092f6..6fb45e7fc7a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem # FakeBelem - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.mdx index cb2d9fd5304..2510348c2a7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 # FakeBelemV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.mdx index 2b694727fca..d967503505f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen # FakeBoeblingen - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Boeblingen backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx index c946579c995..919eeb73a34 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.mdx index f6ce4f69b62..d3ee616e795 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota # FakeBogota - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.mdx index 76844a1eed5..21368536250 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.mdx index 1203cec44f3..1c1e41fa87e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn # FakeBrooklyn - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Brooklyn backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.mdx index dde457b87eb..983deefb8b9 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.mdx index ecef36d1634..3d1f1892658 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington # FakeBurlington - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx index 62c1b6aa731..8c4677f3b3e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.mdx index d601cac37b1..021729925c3 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo # FakeCairo - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.mdx index 9f5d1dfe4f7..118907f0a62 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 # FakeCairoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.mdx index ee6607ece80..3171f7eead5 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge # FakeCambridge - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Cambridge backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.mdx index 354c71358d7..15f69bf13b9 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Cambridge backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.mdx index fdd970e0851..e6b3f33b05a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca # FakeCasablanca - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.mdx index 4917f79f7e5..b11c34f6821 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.mdx index 636cf095c95..0ed25a0c194 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex # FakeEssex - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.mdx index 5b2a6144066..cf43864fc75 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 # FakeEssexV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.mdx index 90837f70833..b23f85b9705 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva # FakeGeneva - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.mdx index b454f306fc3..c3a10b51a1c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe # FakeGuadalupe - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx index dcd7b022eb9..b1e8b50f5aa 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.mdx index fb9ec41ed58..f2eb574de6a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi # FakeHanoi - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.mdx index bf4da3cf32f..ba3decd0dbb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.mdx index f6fc6be5554..73cf339681e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta # FakeJakarta - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.mdx index 729659ea8c1..76f16888043 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.mdx index 24d887741f9..9e96e744d96 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg # FakeJohannesburg - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Johannesburg backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx index b8190d66e2b..9f787954c14 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.mdx index f2891dcef8c..4798df5a836 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata # FakeKolkata - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.mdx index 0d8154d12f8..43f1c2f616c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.mdx index 1ddea815672..defb2b5b8a1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos # FakeLagos - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.mdx index c1e5e56483b..bf878fa6007 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 # FakeLagosV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.mdx index 1996134d565..cb91e964c6f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima # FakeLima - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.mdx index a485656e5b1..73666973e2e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 # FakeLimaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.mdx index 81b44fdf290..e0f4226c36a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon # FakeLondon - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.mdx index 7cde2cc56d2..54843eb81f8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 # FakeLondonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.mdx index a77b7ca4df1..ece6b304b30 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan # FakeManhattan - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Manhattan backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.mdx index 44c247148af..0c4eca93cf1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Manhattan backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.mdx index 38524848f7c..f77216b5285 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila # FakeManila - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.mdx index 687cba9a871..1c4098fc7d1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 # FakeManilaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.mdx index 5d87490e38f..4042ceefe05 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne # FakeMelbourne - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.mdx index eec543e4c34..9b9aa7709ad 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 14 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.mdx index 923d41d0cb4..fc909b646a6 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal # FakeMontreal - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.mdx index 3e72e3b0862..dc0c22cade5 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.mdx index 9597f0b11de..779bf98052a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai # FakeMumbai - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx index 0aee594baf1..b97478f105e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX # FakeMumbaiFractionalCX - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") A fake mumbai backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.mdx index a13a544d4e9..45cd797f17f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.mdx index d49d16de76e..0ba8b77edce 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi # FakeNairobi - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.mdx index 61bec77714c..564438b9e82 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 8970c67fac3..3275008d14f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index d3213a64b9d..5894c929c89 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.mdx index 41857b2caa8..3bd72713979 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo # FakeOslo - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.mdx index 4a9a7760bd2..15586604fd0 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense # FakeOurense - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.mdx index ef1a5690eb9..d6e1818ee18 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.mdx index c392877d7da..143ce912ba7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis # FakeParis - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Paris backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.mdx index ddd5ab73814..ec1b2992448 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 # FakeParisV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Paris backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.mdx index fab25a3f810..25e6828858c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth # FakePerth - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 7 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.mdx index f713f3eb479..cb26f4b2679 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx index c2f6ea2b543..00c69702c5d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.mdx index 4dd6d1bf234..9db29afb5c8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague # FakePrague - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 33 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.mdx index 35e326f007d..9c9b0b31fb7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider # FakeProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx index 06832c4ffed..1e496344e29 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.mdx index 6955c8ba0b0..f55fbdff711 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator # FakeQasmSimulator - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake simulator backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.mdx index 7b69cb6624b..0b8ba2e0381 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito # FakeQuito - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.mdx index 26ab7fa2776..b28c85bd663 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.mdx index e70dcfc18ca..4574d26290e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester # FakeRochester - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Rochester backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.mdx index 5fb91e6329a..ff1cbb41e06 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Rochester backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.mdx index d1865270641..1297e24dca5 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome # FakeRome - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.mdx index 4a305f4b4d2..a0c50d6b44e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 # FakeRomeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.mdx index 12eb044e4a1..1e765553e84 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon # FakeRueschlikon - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 16 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.mdx index 36fb6a3ea16..127c4e3974d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago # FakeSantiago - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake Santiago backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.mdx index 6b0fc002c34..1e98b5fe606 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Santiago backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.mdx index e4458e43be7..e0a1ef83649 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke # FakeSherbrooke - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.mdx index cb1667861aa..9b5d074e355 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore # FakeSingapore - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake Singapore backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.mdx index d1ae798fda5..488f3a8c276 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake Singapore backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.mdx index 9df35b54f93..a74611285f4 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney # FakeSydney - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.mdx index 2a91f27e1b3..b6dc7fc0b20 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.mdx index daa726df8e3..a9a0357a2c8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife # FakeTenerife - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.mdx index c1220240b94..dfb1b3eca60 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo # FakeTokyo - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 20 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.mdx index d2e755bd50b..23e9ec105bd 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto # FakeToronto - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.mdx index 4b318f4e1eb..3bd7d745314 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 27 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.mdx index 6fdd7a4a9c7..7867e8e9c35 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia # FakeValencia - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.mdx index d4f6f7e8ae9..791b16d26ad 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.mdx index c413281b8e8..393c9203592 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo # FakeVigo - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.mdx index eb2497b13ed..40e6b0de92d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 # FakeVigoV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.mdx index 781d8c2078e..060645762ef 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington # FakeWashington - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.mdx index b66287033e5..f5c8928aecf 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 127 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.mdx index a6587f595a7..f748ff2b443 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown # FakeYorktown - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.mdx index aa930e49fef..0c7ebdfd30e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") A fake 5 qubit backend. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.mdx index 2f8cbc49c1e..7b4b3b8c4e0 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 # GenericBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Generic [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") implementation with a configurable constructor. This class will return a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") instance that runs on a local simulator (in the spirit of fake backends) and contains all the necessary information to test backend-interfacing components, such as the transpiler. A [`GenericBackendV2`](#qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") instance can be constructed from as little as a specified `num_qubits`, but users can additionally configure the basis gates, coupling map, ability to run dynamic circuits (control flow instructions), instruction calibrations and dtm. The remainder of the backend properties are generated by randomly sampling from default ranges extracted from historical IBM backend data. The seed for this random generation can be fixed to ensure the reproducibility of the backend output. This backend only supports gates in the standard library, if you need a more flexible backend, there is always the option to directly instantiate a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object to use for transpilation. diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.mdx index 6f37ef985d9..8ca19f1a0ab 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -99,7 +99,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.mdx index f44f667e096..e259a1e3fb1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.mdx index 98650c3ffb0..c9423c2f91c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.Command.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.Command.mdx index 784008cb34f..cf83cd9e271 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.mdx index 06d0ab3cfab..c0082f7140e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.mdx index d0549202459..4451c706263 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateProperties # GateProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a gate’s properties @@ -44,7 +44,7 @@ python_api_name: qiskit.providers.models.GateProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.mdx index b1281001823..3de5ed77bfb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.mdx index 07caa798e25..0aa9df48d8d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Nduv # Nduv - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing name-date-unit-value @@ -50,7 +50,7 @@ python_api_name: qiskit.providers.models.Nduv ### from\_dict - + Create a new Nduv object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.mdx index 048a3c9bbe0..bb1113708fb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.mdx index 7da07b0d17c..8da98744b78 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.mdx index 4dcefbe4390..caab3855c7a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing an OpenQASM 2.0 Backend Configuration. @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.mdx index 0ac625941d4..5ae53965ecb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.mdx index 33287a876f8..054a8b0e0fa 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") 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: diff --git a/docs/api/qiskit/0.46/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.46/qiskit.pulse.Schedule.mdx index fc8b3556619..0974b6f6101 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -338,7 +338,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.mdx index 563d1964f0f..a5483e4713d 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time-ordered sequence of instructions with alignment context. @@ -484,7 +484,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.mdx index a171bc4d18c..d4eddc2943e 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.mdx index 4650b610058..a3c7da9b0af 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.mdx index 8ec00d3b763..ca7c89da088 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.mdx index e39d3cf7531..673da25e920 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.mdx index 52cf91800b5..833ecb78bbf 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.mdx index 06bfcf53ab3..7c7d07a3c81 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.mdx index 29ac951a4ff..a8cb9a4ab04 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.mdx index a09024009b9..dd485120abe 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.mdx index 14cb0d94228..940dd08a26a 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Call # Call - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.mdx index 963f274bab4..8cc0bf5e617 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.mdx index aa8b05fdb1f..188672f302c 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.mdx index 3a75eaf9668..2f33439220a 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.mdx index 0274e98464f..7adf1a29470 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.mdx index 8cfd7b7b6b2..d0ecbfa71ed 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.mdx index d14745921a7..b8e4c37473d 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.mdx index 2cce737f881..2ffad422d9f 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.mdx index 89c9dae770b..df1591cca4f 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.mdx index 5ced59b0550..d98642b8cab 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.mdx index 06ce6c9e62a..048da57187b 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.mdx index 7779f9b4fda..42aedc36094 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.mdx index c935e479f7c..aa0ad7e206e 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.mdx index c134290ddc1..35fc3df1509 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.mdx index 99544746122..8bca9bda222 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.mdx index b8c071f8aac..0950ec85634 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse # ParametricPulse - + Bases: `Pulse` The abstract superclass for parametric pulses. @@ -95,7 +95,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. **Return type** @@ -115,7 +115,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse ### validate\_parameters - + Validate parameters. **Raises** diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.mdx index 94d9fe5b2c7..d01c7332464 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.mdx index bd3a7ddf708..6a201877c77 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.mdx index 414a56f73f4..4c258bc9175 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.mdx index a52bfc737ba..6644c95f24b 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.mdx index 42df9955cd9..f48347ebfd6 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.mdx index 1f23fa5c49d..2650d78e8fa 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.mdx index 6773713cbe2..e2b48327638 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.mdx index c1d16b88076..0d72e3acd7a 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.mdx index 3332bba55b9..180a44b045e 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.mdx index 8006b4a26c7..1bd242ded0b 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.mdx index 56394a8b3e9..c1094f5e097 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `QobjDictField` A configuration for a Pulse Qobj. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.mdx index 8b919c57c01..4810ffbc39c 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.mdx index 8e9e4ee41e5..637aa789836 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.mdx index 89487ca6106..1daf9be2f0d 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.mdx index bc4994d37ad..f354544af0c 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.mdx index dabd7d7254f..18e8ed32f4a 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.mdx index 97dbd6e8e65..9d170852f2e 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") A configuration for an OpenQASM 2 Qobj. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.mdx index d24be5cd3c4..388a6596731 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.mdx index 4531fe7b44c..7a94a37979b 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `QobjDictField` Configuration for a single OpenQASM 2 experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.mdx index 9c359fea3ef..d9cb53a28a5 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.mdx index 8def4a0f8b9..2ac8c1bebb8 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.mdx index df0e293c0ca..9c9b27d071e 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.mdx index e12062eef3e..97245f1b5b9 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.mdx index 9bf9423ca20..0eb0ad90637 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.mdx index e8acb25493b..8cfd6fb0674 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.mdx index 7e3fb7cbe18..d44ab09cfa2 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.mdx index 43fe8f31967..19dfa0a1592 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -265,7 +265,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -287,13 +287,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -341,7 +341,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_linear\_function - + Create a Clifford from a Linear Function. If the linear function is represented by a nxn binary invertible matrix A, then the corresponding Clifford has symplectic matrix \[\[A^t, 0], \[0, A^\{-1}]]. @@ -361,7 +361,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -385,7 +385,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -409,7 +409,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_permutation - + Create a Clifford from a PermutationGate. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.mdx index 0f8e081189d..f99c14f1fe6 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -184,7 +184,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -208,7 +208,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.mdx index 31375334d47..64b4b906256 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.mdx index 1dc9b9f5d5d..128bf1c1859 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -254,7 +254,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -279,7 +279,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.mdx index 1ca2d073bb8..a7977cebf0f 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.mdx index 31087ae6044..ed8dc04caf4 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -454,7 +454,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.mdx index 1145640ff06..162eb228bda 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -424,7 +424,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.mdx index 41c47962a2f..49d14a78590 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.mdx index 5bb4f422bd0..662f6ca9f62 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.mdx index 3bae19b243f..811cc8120a1 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -365,7 +365,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -403,7 +403,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. @@ -429,7 +429,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -710,7 +710,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.mdx index 6f9225154d4..ee6a7155730 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.mdx index db4010c12de..38cd0ff19ec 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.mdx index abb1809896d..a11911083c1 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.mdx index 0760f6e7c2d..cd232c928c4 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.mdx index c14fe6a31ea..f71c25ff4e0 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -111,7 +111,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries ### find\_z2\_symmetries - + Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). **Returns** diff --git a/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.mdx index 4053d97f1af..1387e9b00e9 100644 --- a/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.mdx index 6290f929bd6..239be749326 100644 --- a/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/0.46/qiskit.result.Counts.mdx b/docs/api/qiskit/0.46/qiskit.result.Counts.mdx index d1ebf187c4c..c0f4ecabddc 100644 --- a/docs/api/qiskit/0.46/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.mdx index 9a626013a49..571aeeca33a 100644 --- a/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.mdx index 9a0a8c4dfef..6d0c9e4010e 100644 --- a/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.mdx index e4c9d0a1772..cbb9918d7fd 100644 --- a/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/0.46/qiskit.result.Result.mdx b/docs/api/qiskit/0.46/qiskit.result.Result.mdx index f20f7743464..a599438a4e3 100644 --- a/docs/api/qiskit/0.46/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.result.ResultError.mdx b/docs/api/qiskit/0.46/qiskit.result.ResultError.mdx index e0275b4e751..94e9a56bcac 100644 --- a/docs/api/qiskit/0.46/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/0.46/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.mdx index 2353d350cca..c1ed927a84e 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for evolution synthesis algorithms. @@ -33,7 +33,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.mdx index acf9fa61ce0..e18783725d6 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.mdx index 85b692a8ddc..79df2a93ef0 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.mdx index 71359907705..4990d72ce5d 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.mdx index 848c1fb4e1c..7dd5db11bbd 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -43,7 +43,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.mdx index 10cb64b0bbe..14420ebd8aa 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.mdx index c3b0d745d26..89751a6072b 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.mdx index f1152fc8567..1f277fc9707 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.mdx index a3a9a0957ab..d46060289ae 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -24,7 +24,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer ### decomp0 - + 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 diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.mdx index 58b5e9eecd4..6cefd55ad00 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.XXDecomposer # XXDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.mdx index d9e9a41bca7..fd721a699e7 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC # AQC - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A generic implementation of the Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 4fc9ae3fba2..1eb3435c0a7 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class that represents an approximate circuit. @@ -215,7 +215,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit ### build - + **Constructs this circuit out of the parameters(thetas). Parameter values must be set before** constructing the circuit. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx index 2edf5f45278..3806ce8fca8 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -31,7 +31,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index 68a28cc6fbc..b8955ab311e 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`ApproximateCircuit`](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx index bab4e5cd186..af6c2dc706c 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx index c86b55f97ba..fc5ee377eec 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index c9c36261c57..77c0358b290 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.mdx index ffaef1a1bc8..7a74feae4b7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `BasePass` An analysis pass: change property set, not DAG. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.mdx index 66ca0e6ee2e..7a3bd1ee4f9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Directed graph specifying fixed coupling. @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -224,7 +224,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -247,7 +247,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.mdx index b56a7625aff..c486db7ee54 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit # FencedDAGCircuit - + Bases: `FencedObject` A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.mdx index 60886888664..4418e3c19f7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet # FencedPropertySet - + Bases: `FencedObject` A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.mdx index d7a3080ea3e..80ddad2c16d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.mdx index bdb53924059..1bb18a4b143 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.Layout.mdx index 694ffd19b29..2d4b2f2caa8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Two-ways dict to represent a Layout. @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -136,7 +136,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -159,7 +159,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -195,7 +195,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.mdx index b366b202f2b..2f2112b9a4c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.mdx index d967258b5dd..6b6f8d76e48 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.mdx index 2d336ec1de3..6f2ce7bdfb9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A pass manager pipeline built from individual stages. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.Target.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.Target.mdx index 3d4c22dfc3d..6f012bcb424 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -256,7 +256,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.mdx index 66f9fafdea4..d2659465296 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `BasePass` A transformation pass: change DAG, not property set. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.mdx index 8961fabcb76..115225bd0cb 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Layout attributes from output circuit from transpiler. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.mdx index 6eaddc83138..63182c5caff 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 015b76236b8..7973b2a3384 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.mdx index 794b9b0ed99..ceac015b407 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AQCSynthesisPlugin # AQCSynthesisPlugin - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.mdx index e6a361bf767..5af45ea252a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 7ab76ddb89b..8038ed78c6f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.mdx index 455b4cb4b8a..c3c0bb7e1d8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.mdx index 83319ad5720..e43f11ff241 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 55c2cdf36f6..ba5657ce19f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.mdx index 6de593c537c..2f834e11373 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a `coupling_map` adding swap gates. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.mdx index 44eaf722b17..e3aa8a5ebfd 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.mdx index d03a7c0a21b..6c1dd108a48 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.mdx index fd79c33a37a..06d7921a0aa 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back `cx` gates in dag. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.mdx index 358c2a61435..9c039e31a6b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.mdx index ab314fe729c..9bf509fe0d1 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.mdx index f4afacf2197..d6a3f115efc 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.mdx index bed421028e4..3c686f95e8f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.mdx index 1d3a58ebffb..97ce3e1ece5 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.mdx index f23da5ca61f..d40c971a3c9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `CollectAndCollapse` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index a6feb8c752b..0c81d51c89e 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. `max_block_size` specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.mdx index 66d1edf9ef7..d6770b857c8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.mdx index c28b43d5764..7fbf936a429 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index 30219c5df05..a0ff81d2314 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 6db11917366..9600f0c3e81 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.mdx index 0b654d91ba9..e959a8fbb74 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.mdx index 32aa89c0608..74f92c30924 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.mdx index 5d33dc49042..2ff843fcfb2 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index bb487733d7b..fe5ba5a4d3c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.mdx index ba5b4ec8c63..780fc84bc39 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 7ebdc7147f2..3ea04f2032d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx index a6208050d8e..2468220c4dc 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule # CrosstalkAdaptiveSchedule - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.mdx index a46ea397ab8..a67c9b20b3a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.mdx index c0d054ff825..a89ed92d5a7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") as a list of [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")s, [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")s, and [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")s. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.mdx index d3d863d5a60..2ad6f1f25c0 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.mdx index acec473b165..9f890a662c0 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.mdx index f79709c9510..25de143a767 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.mdx index d686ac87395..25c4c8108c4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index c87afbf3c30..9e7288c0661 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index e7f3cb5c385..cf6f4a79382 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.mdx index b0d9458aa80..2a076796389 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.mdx index efe653765ac..7ca19178c0e 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map or target as ancilla on the layout. @@ -122,7 +122,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in `layout_qregs` already exist in `dag_qregs`. Otherwise, raise. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.mdx index febbd09ebba..46d59c70b94 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.mdx index 3a8c9980309..d9a38b09263 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.mdx index fe08c8a4b02..a5946ab8ab7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects and unroll custom definitions. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.mdx index ec55ec3d0ca..3ff8ad6b4b4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 8d6358ee998..725720e2202 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.mdx index 20a1070ae90..b16c0ab30a7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.mdx index 944044cd75f..f0534f46698 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx index 0dab5b65837..2b3946ed632 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis # LinearFunctionsSynthesis - + Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") DEPRECATED: Synthesize linear functions. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 8c4926b3362..e4e5ed24649 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.mdx index bf9a1c87464..4a84cbd5815 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index aaf1e37107d..29883e01374 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.mdx index a1ceeee1a4b..4e4dfa2bb78 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint # MinimumPoint - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Check if the DAG has reached a relative semi-stable point over previous runs diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx index 93c558cad21..d10042c38ba 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout # NoiseAdaptiveLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.mdx index a132647431f..6b0651a4118 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle # NormalizeRXAngle - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Normalize theta parameter of RXGate instruction. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.mdx index 1205a2ea61e..20f0975b484 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.mdx index 5449ba5e005..f2e6501c407 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -43,7 +43,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -126,7 +126,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 3df95333805..267804c82c8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 76fa1bf5285..4e9c05dde53 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and resynthesizing the results. The commutation rules are stored in `commutation_table`. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.mdx index 34496af0567..3e8bc07df1b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.mdx index fd61cebb0ed..52ea39401b2 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 8913023766a..93768bfbffc 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.mdx index dedcbfff802..83335e3bbdf 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.mdx index 8d70c969957..204749e846f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder # RXCalibrationBuilder - + Bases: `CalibrationBuilder` Add single-pulse RX calibrations that are bootstrapped from the SX calibration. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index c968c0a22da..b2c4ae3b69e 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index bb6d69fe244..ca14e0b3242 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.mdx index 2b0f11f2897..c2f0fcdd95c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 4db5b5fedcc..a97a7f2fc0c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 86d6795eb37..bb661a07f39 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 389ac7a641c..7cab9b0ed2b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index ca71d756a16..2db930850db 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.mdx index 933d6ca4cb1..bb9b8714f7f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.mdx index eae71746622..62b4dea746f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout # SabrePreLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a starting layout to use for additional Sabre layout trials. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.mdx index e5f30cc89b0..d2a467da7a8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.mdx index 013d4febf8f..2af01e17d40 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.mdx index b8d4efe709a..df88f1a4e4b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.mdx index c7e7e394273..bba974b5849 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.mdx index 513f0c23540..4d3f5cf7282 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx index 0f1d1dbca71..ef625914230 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.mdx index 53a4afdea1e..a058f349d0a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.mdx index d4bd7b9f6ae..ca3266fb25a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.mdx index fac9bc47df0..b5f7efbf7ed 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index c4f61c3d66d..309b25bf40d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.mdx index 580be081bfd..c8ec2c72679 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.mdx index 2a2389134e3..4dbc69d0417 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.mdx index e7483df9eb0..79b78d3e6e5 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 1b81ff4d1f2..f54c8c1da50 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.mdx index a8ad051496c..5a24edcf84d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops # UnrollForLoops - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.mdx index 67209640cb9..25fc509b2b9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroller # Unroller - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.mdx index e78044943ce..e3d9132dd64 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.mdx index 25ca3621224..158100f5718 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.mdx index 22c3714e10e..896a8f2db97 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.mdx index 9f285203ee9..662ad219788 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index f1c98d4cc73..3300032153d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 6bf959c301d..8d6fdeeeca3 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 752a79055e3..a0eedbe0ee8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract unitary synthesis plugin class @@ -176,7 +176,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 4cf3d76b401..99e4356a88e 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index a7c5d58470b..267afe7675b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 3e5f322dc33..81792d0ca9c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.mdx b/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.mdx index 1f90fff7758..29ec9140911 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.mdx +++ b/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.QuantumInstance # QuantumInstance - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.mdx b/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.mdx index a3b2f2c268b..dabc00022fb 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.mdx +++ b/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter # CompleteMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.mdx b/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.mdx index dc6b5b4887e..1cc94f42a29 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.mdx +++ b/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter # TensoredMeasFitter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Deprecated: Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.mdx b/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.mdx index 1eac45b1abf..7550c50f309 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.mdx +++ b/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.circuit.qcstyle.DefaultStyle # DefaultStyle - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.mdx b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.mdx index f500ee1d3cd..23ce81d62a5 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.mdx +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging # IQXDebugging - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.mdx b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.mdx index 2675df636ce..9c721df8bae 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.mdx +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple # IQXSimple - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.mdx b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.mdx index c28f0f345be..f4a525ec2fe 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.mdx +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard # IQXStandard - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.46/qpy.mdx b/docs/api/qiskit/0.46/qpy.mdx index 2f606de64cc..28e89aff6d2 100644 --- a/docs/api/qiskit/0.46/qpy.mdx +++ b/docs/api/qiskit/0.46/qpy.mdx @@ -154,7 +154,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski #### QpyError - + Errors raised by the qpy module. Set the error message. diff --git a/docs/api/qiskit/0.46/scheduler.mdx b/docs/api/qiskit/0.46/scheduler.mdx index f2ccf15b9a5..5afce93783a 100644 --- a/docs/api/qiskit/0.46/scheduler.mdx +++ b/docs/api/qiskit/0.46/scheduler.mdx @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/0.46/tools.mdx b/docs/api/qiskit/0.46/tools.mdx index 7d801d8f062..66f60e8c7fc 100644 --- a/docs/api/qiskit/0.46/tools.mdx +++ b/docs/api/qiskit/0.46/tools.mdx @@ -95,7 +95,7 @@ A helper component for publishing and subscribing to events. #### TextProgressBar - + A simple text-based progress bar. **output\_handlerthe handler the progress bar should be written to, default** diff --git a/docs/api/qiskit/0.46/transpiler.mdx b/docs/api/qiskit/0.46/transpiler.mdx index 9ef33b0717d..a85f3e3154c 100644 --- a/docs/api/qiskit/0.46/transpiler.mdx +++ b/docs/api/qiskit/0.46/transpiler.mdx @@ -940,7 +940,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError - + Exceptions raised during transpilation. Set the error message. @@ -948,7 +948,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -956,7 +956,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError - + Base class for errors raised by the coupling graph object. Set the error message. @@ -964,7 +964,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError - + Errors raised by the layout object. Set the error message. diff --git a/docs/api/qiskit/0.46/utils.mdx b/docs/api/qiskit/0.46/utils.mdx index 9b22e728406..7380ac2796f 100644 --- a/docs/api/qiskit/0.46/utils.mdx +++ b/docs/api/qiskit/0.46/utils.mdx @@ -517,7 +517,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -557,7 +557,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -624,7 +624,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -638,7 +638,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/0.46/visualization.mdx b/docs/api/qiskit/0.46/visualization.mdx index fac30bf59c7..a158193e20d 100644 --- a/docs/api/qiskit/0.46/visualization.mdx +++ b/docs/api/qiskit/0.46/visualization.mdx @@ -235,7 +235,7 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError - + For visualization specific errors. Set the error message. diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx index aa970918b45..bd1946ddc15 100644 --- a/docs/api/qiskit/dev/circuit.mdx +++ b/docs/api/qiskit/dev/circuit.mdx @@ -255,7 +255,7 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Bit - + Implement a generic bit. @@ -267,7 +267,7 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Qubit - + Bases: [`Bit`](#qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a quantum bit. @@ -275,7 +275,7 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Clbit - + Bases: [`Bit`](#qiskit.circuit.Bit "qiskit.circuit.bit.Bit") Implement a classical bit. @@ -285,7 +285,7 @@ Qubits and clbits are instantiated by users with no arguments, such as by `Qubit #### AncillaQubit - + Bases: [`Qubit`](#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") A qubit used as ancillary qubit. @@ -295,7 +295,7 @@ A collection bits of the same type can be encapsulated in a register of the matc #### Register - + Implement a generic register. @@ -343,7 +343,7 @@ Each of the defined bit subtypes has an associated register, which have the same #### QuantumRegister - + Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. @@ -351,7 +351,7 @@ Each of the defined bit subtypes has an associated register, which have the same #### ClassicalRegister - + Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. @@ -359,7 +359,7 @@ Each of the defined bit subtypes has an associated register, which have the same #### AncillaRegister - + Bases: [`QuantumRegister`](#qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. @@ -435,19 +435,19 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera #### InverseModifier - + Inverse modifier: specifies that the operation is inverted. #### ControlModifier - + Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. #### PowerModifier - + Power modifier: specifies that the operation is raised to the power `power`. @@ -461,7 +461,7 @@ Measurements in Qiskit are of a single [`Qubit`](#qiskit.circuit.Qubit "qiskit.c #### Measure - + Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") Quantum measurement in the computational basis. @@ -475,7 +475,7 @@ Related to measurements, there is a [`Reset`](#qiskit.circuit.Reset "qiskit.circ #### Reset - + Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") Incoherently reset a qubit to the $\lvert0\rangle$ state. @@ -489,7 +489,7 @@ Hardware can be instructed to apply a real-time idle period on a given qubit. A #### Delay - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Do nothing and just delay/wait/idle for a specified duration. @@ -515,7 +515,7 @@ it is forbidden for the optimizer to cancel out the two $X$ instructions. #### Barrier - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A directive for circuit compilation to separate pieces of a circuit so that any optimizations or re-writes are constrained to only act between barriers. @@ -532,7 +532,7 @@ The [`Store`](#qiskit.circuit.Store "qiskit.circuit.Store") instruction is parti #### Store - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A manual storage of some classical value to a classical memory location. @@ -939,7 +939,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c ### CircuitError - + Base class for errors raised while processing a circuit. Set the error message. diff --git a/docs/api/qiskit/dev/circuit_classical.mdx b/docs/api/qiskit/dev/circuit_classical.mdx index 68b1babab30..e30c1607eab 100644 --- a/docs/api/qiskit/dev/circuit_classical.mdx +++ b/docs/api/qiskit/dev/circuit_classical.mdx @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr - + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -64,7 +64,7 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var #### Var - + A classical variable. These variables take two forms: a new-style variable that owns its storage location and has an associated name; and an old-style variable that wraps a [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instance that is owned by some containing circuit. In general, construction of variables for use in programs should use `Var.new()` or [`QuantumCircuit.add_var()`](qiskit.circuit.QuantumCircuit#add_var "qiskit.circuit.QuantumCircuit.add_var"). @@ -88,7 +88,7 @@ Similarly, literals used in expressions (such as integers) should be lifted to [ #### Value - + A single scalar value. @@ -96,7 +96,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary - + A unary expression. **Parameters** @@ -107,7 +107,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -130,7 +130,7 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary - + A binary expression. **Parameters** @@ -142,7 +142,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -237,7 +237,7 @@ Bit-like types (unsigned integers) can be indexed by integer types, represented #### Index - + An indexing expression. **Parameters** @@ -253,7 +253,7 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast - + A cast from one type to another, implied by the use of an expression in a different context. @@ -714,7 +714,7 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor - + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. ##### visit\_binary @@ -917,7 +917,7 @@ All types inherit from an abstract base class: #### Type - + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -929,13 +929,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](c #### Bool - + The Boolean type. This has exactly two values: `True` and `False`. #### Uint - + An unsigned integer of fixed bit width. @@ -982,7 +982,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. #### Ordering - + Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. @@ -1108,7 +1108,7 @@ The return values from this function are an enumeration explaining the types of #### CastKind - + A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/dev/circuit_singleton.mdx b/docs/api/qiskit/dev/circuit_singleton.mdx index 72fa1d99a1d..aed0e118dbb 100644 --- a/docs/api/qiskit/dev/circuit_singleton.mdx +++ b/docs/api/qiskit/dev/circuit_singleton.mdx @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonInstruction - + A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") which has an immutable definition and any instance of [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions. @@ -56,7 +56,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonGate - + A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -64,7 +64,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonControlledGate - + A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -126,7 +126,7 @@ Subclasses of [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstru #### \_singleton\_lookup\_key - + Given the arguments to the constructor, return a key tuple that identifies the singleton instance to retrieve, or `None` if the arguments imply that a mutable object must be created. For performance, as a special case, this method will not be called if the class constructor was given zero arguments (e.g. the construction `XGate()` will not call this method, but `XGate(label=None)` will), and the default singleton will immediately be returned. diff --git a/docs/api/qiskit/dev/dagcircuit.mdx b/docs/api/qiskit/dev/dagcircuit.mdx index 63cafb3d60b..d2a5d0a5174 100644 --- a/docs/api/qiskit/dev/dagcircuit.mdx +++ b/docs/api/qiskit/dev/dagcircuit.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError - + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -42,7 +42,7 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError - + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/dev/exceptions.mdx b/docs/api/qiskit/dev/exceptions.mdx index 5fde4290ca6..c03e83fcf6d 100644 --- a/docs/api/qiskit/dev/exceptions.mdx +++ b/docs/api/qiskit/dev/exceptions.mdx @@ -24,7 +24,7 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: ### QiskitError - + Base class for errors raised by Qiskit. Set the error message. @@ -40,7 +40,7 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError - + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any @@ -50,7 +50,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError - + Raised when an error is encountered reading a user config file. Set the error message. @@ -58,7 +58,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError - + Raised when the file provided is not valid for the specific task. Set the error message. @@ -70,7 +70,7 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit ### QiskitWarning - + Common subclass of warnings for Qiskit-specific warnings being raised. @@ -78,7 +78,7 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib ### OptionalDependencyImportWarning - + Raised when an optional library raises errors during its import. @@ -90,7 +90,7 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni ### ExperimentalWarning - + Raised when an experimental feature is being used. diff --git a/docs/api/qiskit/dev/passmanager.mdx b/docs/api/qiskit/dev/passmanager.mdx index b837cb33924..f9c7d4bddd6 100644 --- a/docs/api/qiskit/dev/passmanager.mdx +++ b/docs/api/qiskit/dev/passmanager.mdx @@ -162,7 +162,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza #### PassManagerError - + Pass manager error. Set the error message. diff --git a/docs/api/qiskit/dev/providers.mdx b/docs/api/qiskit/dev/providers.mdx index 0f7ddfa3338..4e3e0f3c2be 100644 --- a/docs/api/qiskit/dev/providers.mdx +++ b/docs/api/qiskit/dev/providers.mdx @@ -77,7 +77,7 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### QiskitBackendNotFoundError - + Base class for errors raised while looking for a backend. Set the error message. @@ -85,7 +85,7 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendPropertyError - + Base class for errors raised while looking for a backend property. Set the error message. @@ -93,7 +93,7 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobError - + Base class for errors raised by Jobs. Set the error message. @@ -101,7 +101,7 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobTimeoutError - + Base class for timeout errors raised by jobs. Set the error message. @@ -109,7 +109,7 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendConfigurationError - + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/dev/providers_fake_provider.mdx b/docs/api/qiskit/dev/providers_fake_provider.mdx index 60b83fa3b06..7847c244d3c 100644 --- a/docs/api/qiskit/dev/providers_fake_provider.mdx +++ b/docs/api/qiskit/dev/providers_fake_provider.mdx @@ -83,7 +83,7 @@ The V1 fake backends are based on a set of base classes: ### FakeBackend - + This is a dummy backend just for testing purposes. FakeBackend initializer. @@ -96,7 +96,7 @@ The V1 fake backends are based on a set of base classes: ### FakeQasmBackend - + A fake OpenQASM backend. FakeBackend initializer. @@ -109,7 +109,7 @@ The V1 fake backends are based on a set of base classes: ### FakePulseBackend - + A fake pulse backend. FakeBackend initializer. diff --git a/docs/api/qiskit/dev/pulse.mdx b/docs/api/qiskit/dev/pulse.mdx index fbaaa4c0a91..9d756120f19 100644 --- a/docs/api/qiskit/dev/pulse.mdx +++ b/docs/api/qiskit/dev/pulse.mdx @@ -72,7 +72,7 @@ These are all instances of the same base class: ### Instruction - + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -165,7 +165,7 @@ All channels are children of the same abstract base class: ### Channel - + 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. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -220,7 +220,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind - + An abstract class for schedule alignment. Create new context. @@ -2022,7 +2022,7 @@ There are 1e-06 seconds in 4500 samples. ### PulseError - + Errors raised by the pulse module. Set the error message. @@ -2030,7 +2030,7 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet - + Raised if the builder context does not have a backend. Set the error message. @@ -2038,7 +2038,7 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder - + Raised if no builder context is active. Set the error message. @@ -2046,7 +2046,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError - + Raised if instruction duration is unassigned. Set the error message. @@ -2054,7 +2054,7 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError - + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/dev/qasm2.mdx b/docs/api/qiskit/dev/qasm2.mdx index 27f28070760..a7a1f6f53c0 100644 --- a/docs/api/qiskit/dev/qasm2.mdx +++ b/docs/api/qiskit/dev/qasm2.mdx @@ -85,7 +85,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -103,7 +103,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -164,7 +164,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error - + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -174,7 +174,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError - + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -184,7 +184,7 @@ When the exporters fail to export a circuit, likely because it has structure tha ### QASM2ExportError - + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/dev/qasm3.mdx b/docs/api/qiskit/dev/qasm3.mdx index 6ee1a6aad5b..5ca816a515a 100644 --- a/docs/api/qiskit/dev/qasm3.mdx +++ b/docs/api/qiskit/dev/qasm3.mdx @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + QASM3 exporter main class. **Parameters** @@ -107,7 +107,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError - + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -119,7 +119,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -259,7 +259,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError - + An error raised during the OpenQASM 3 importer. Set the error message. @@ -393,7 +393,7 @@ These two functions allow for specifying include paths as an iterable of paths, #### CustomGate - + Information received from Python space about how to construct a Python-space object to represent a given gate that might be declared. diff --git a/docs/api/qiskit/dev/qiskit.assembler.RunConfig.mdx b/docs/api/qiskit/dev/qiskit.assembler.RunConfig.mdx index e377222f52e..b7412d055b4 100644 --- a/docs/api/qiskit/dev/qiskit.assembler.RunConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.assembler.RunConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig # RunConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") Class for Run Configuration. @@ -67,7 +67,7 @@ python_api_name: qiskit.assembler.RunConfig ### from\_dict - + Create a new RunConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx index d2f73878431..7244e0fda91 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation # AnnotatedOperation - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Annotated operation. diff --git a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx index 18ca72d9176..941748847f5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp # BreakLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. Can only be used inside loops. diff --git a/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx index e686ce3d3bc..909fe6e68cf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx index 08ce2e68244..d0478af16d8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp # ContinueLoopOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. Can only be used inside loops. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx index 5d48c114e74..f088627569d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class to encapsulate all control flow operations. @@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Return a new version of this control-flow operations with the [`blocks`](#qiskit.circuit.ControlFlowOp.blocks "qiskit.circuit.ControlFlowOp.blocks") mapped to the given new ones. Typically this is used in a workflow such as: diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx index 645a3f1268b..bdfb54dda22 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate # ControlledGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Controlled unitary gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx index ae6e8a876cc..a9feae0eb98 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx index c20f52fc9fd..d4452a25b0b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp # ForLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx index 11060e63ec3..e2e862bc4f9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate # Gate - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Unitary gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx index a087e139ac2..024a87d23fb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp # IfElseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx index 03ac1e6e189..51caea613a1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. diff --git a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx index 4c239a42062..c227279a4aa 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Operation.mdx b/docs/api/qiskit/dev/qiskit.circuit.Operation.mdx index 4a92aeb186a..98d23603082 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Operation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation # Operation - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Quantum operation interface. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx index 6de51b7a7bc..bae96e6ea82 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter # Parameter - + Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") A compile-time symbolic parameter. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.mdx index 659d7466270..1395c9d5eec 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.mdx index 29c5a3bab7f..40a1916f100 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx index 4cfa2058d03..ad38aab0eb8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # QuantumCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Create a new circuit. @@ -615,7 +615,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. **Return type** @@ -721,7 +721,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. **Return type** @@ -731,7 +731,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. **Return type** @@ -1517,7 +1517,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of CircuitInstructions. **Parameters** @@ -1540,7 +1540,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -1562,7 +1562,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx index 9019d9bf085..0ca4cc1ee8e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp # SwitchCaseOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") can be used to represent a default condition. diff --git a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx index 8376f9bb67a..aeabe06c262 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp # WhileLoopOp - + Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx index d3ad86591d6..4a663ecec87 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression # BooleanExpression - + Bases: `ClassicalElement` The Boolean Expression gate. @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### from\_dimacs\_file - + Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index e308974c454..3f6ba4fe72e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction # ClassicalFunction - + Bases: `ClassicalElement` Represent a classical function and its logic network. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 487b154fcb2..ffde80605fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError - + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index f58d97673ab..4db718ce921 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError - + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx index 4a05cb65fbb..93de850ff3d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND # AND - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx index 96f136674ce..42cd0fc0d4a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx index c0f64ab2c82..c601cf906ad 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx index 88051ce2ea9..d1058b22160 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx index 7efd7ef5b62..55f27ce0f60 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx index e94d86ba677..8824f122105 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate # CCZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCZ gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 3aaeb23313f..6bf7b0f4a13 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder # CDKMRippleCarryAdder - + Bases: `Adder` A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx index d6b7742eaa5..2cb381c36e9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx index 0c58e76fee8..a8478d4483c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate # CPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-Phase gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx index 63ebd967ec0..541ba942190 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx index ce05f7dee41..d4994ee18e1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx index 98475d99cad..2634260deef 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx index 4b428ff363f..6f2bb0e9cbc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate # CSGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx index 2227111e3ec..a3cdea12757 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx index 7903fa5c29c..c714ffc3313 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate # CSdgGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-S^dagger gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx index 37dc3c38c00..4120dce87ed 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate # CSwapGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx index a094fa5aefe..9f7db79dbb1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx index 4c960979767..d4ee7691a6c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx index 06f13ddbd93..7d33686dd0a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx index f10cc2a47b9..236b8a72457 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx index 1b58180e2fb..287c77d86ca 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Y gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx index 58aa9467b29..6f71854c14b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate # CZGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Z gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx index fe008726351..09f25a1571a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Double-CNOT gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx index 52e94d432c2..59e89391135 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal # Diagonal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Diagonal circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx index 854ad75f441..052d786f88c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate # DiagonalGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Gate implementing a diagonal transformation. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx index 7e617362224..11d716999ed 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder # DraperQFTAdder - + Bases: `Adder` A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx index 766e31cc8ef..8e4aeaf600d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate # ECRGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") An echoed cross-resonance gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx index 546b289e533..feaa35e5104 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 # EfficientSU2 - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 187ce12064e..bb565a9c69a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz # EvolvedOperatorAnsatz - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The evolved operator ansatz. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx index 58f85285327..61a124f5fce 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal # ExactReciprocal - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Exact reciprocal diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx index e762aabe682..da56cc6f02d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving # ExcitationPreserving - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx index 72cb5e29b21..a72bc246d37 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking # FourierChecking - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Fourier checking circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx index 4c23f06ebf8..d3e944489b3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - + Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx index bd4fd91125a..d92d8d329c0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS # GMS - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx index a5887cc7bc2..f39e9ff6766 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR # GR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global R gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx index 73d6e4ee493..8f811dedffe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX # GRX - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RX gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx index d2f1e8c5ed9..079f4d2229a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY # GRY - + Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") Global RY gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx index 985f1d45403..e74821baffe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ # GRZ - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Global RZ gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx index 09e4e2a7b81..4b9558d26b6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate # GlobalPhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") The global phase gate ($e^{i\theta}$). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx index df90930f59b..c7ee7f8c756 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState # GraphState - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx index f9cd54e6a1a..e95caed32db 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator # GroverOperator - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The Grover operator. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx index 72e839fa453..0a09fe6e5e4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate # HGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 392358c8ca8..2dbd61f84dd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier # HRSCumulativeMultiplier - + Bases: `Multiplier` A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx index 2b8d20a4079..5918611a2e9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate # HamiltonianGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class for representing evolution by a Hamiltonian operator as a gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx index eb1f8a153f5..5cbe9fe6128 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction # HiddenLinearFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx index b42ccd1b806..1a9124ac5f3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Identity gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx index 8441e610c0d..6475bf8f7af 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP # IQP - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx index adcf69ece7c..d65856b48b4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Initialize # Initialize - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Complex amplitude initialization. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx index 9969ea7f24c..e6d42dee0d5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.InnerProduct # InnerProduct - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx index 967b01e8519..91e192e4b18 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator # IntegerComparator - + Bases: `BlueprintCircuit` Integer Comparator. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx index 8c23f22699b..ef8c437939a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Isometry # Isometry - + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") Decomposition of arbitrary isometries from $m$ to $n$ qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx index aaf5bee8dad..f548dd391ea 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction # LinearAmplitudeFunction - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx index bd0bdff7235..73e23a4d968 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearFunction # LinearFunction - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A linear reversible circuit on n qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx index 9204441dd37..170bda93d79 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations # LinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx index 9051eca9094..ce12fd35e85 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMT # MCMT - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx index 27a8ed5c794..99737a00ebd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain # MCMTVChain - + Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx index 24b5ca64ac3..bccefed3e87 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx index f711179d86f..7cb401f7c52 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -181,7 +181,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx index 243c24adb93..8ce27c1fcdc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx index 83116e53bea..ce98e43d8d4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx index 76fd3761fef..2fe4ae1b65c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx index d797ab09c1c..c635fc01e48 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MSGate # MSGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx index f6fc36496f8..8fd22018760 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.NLocal # NLocal - + Bases: `BlueprintCircuit` The n-local circuit class. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx index 39e6ae63024..a6d0d76d271 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.OR # OR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx index 161b8694e05..4c4256d40ae 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx index df13b03d098..2fbb81402be 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx index 7087252b69d..b9511cdc35e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliGate # PauliGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx index b91bed5f4d2..f50246cdec6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign # PauliTwoDesign - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx index ad74c3846ea..ecb9a5c3fd7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Permutation # Permutation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx index 01fd689af85..19abcb65d02 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PermutationGate # PermutationGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A gate that permutes qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx index 48c400adc02..06a95b1222e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation # PhaseEstimation - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx index 897a9cfa32a..20ee162047f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseGate # PhaseGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx index 70dc5aa0fb8..29e746e1e58 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle # PhaseOracle - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Oracle. @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### from\_dimacs\_file - + Create a PhaseOracle from the string in the DIMACS format. It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx index 2c3392563db..3972abb335e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev # PiecewiseChebyshev - + Bases: `BlueprintCircuit` Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index e0cd0ad87ea..51ccdf16f58 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations # PiecewiseLinearPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index ed922d8c43b..4fc0283d32f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations # PiecewisePolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx index cc276be8d27..9f09e454b8b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations # PolynomialPauliRotations - + Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx index 4d4795999db..77f87e29017 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz # QAOAAnsatz - + Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.n_local.evolved_operator_ansatz.EvolvedOperatorAnsatz") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx index 851fc5df5fe..ac59fea9b25 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QFT # QFT - + Bases: `BlueprintCircuit` Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx index f100d414c01..0e0016cbb68 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm # QuadraticForm - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Implements a quadratic form on binary variables encoded in qubit registers. @@ -260,7 +260,7 @@ $$ ### required\_result\_qubits - + Get the number of required result qubits. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx index 370f75a9be8..a0eb8fe0f55 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume # QuantumVolume - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") A quantum volume model circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx index 23d6944756c..824605c4a23 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx index 82b25b4fce6..0b517c029b2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx index 08141971733..f9bf39c4643 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier # RGQFTMultiplier - + Bases: `Multiplier` A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx index d14c920cf6f..e06d41de605 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RGate # RGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx index 47e391ca163..7e1fa3607a1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RVGate # RVGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Rotation around arbitrary rotation axis $\vec{v}$ where $\|\vec{v}\|_2$ is angle of rotation in radians. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx index 976c829fe61..904239c5809 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXGate # RXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx index 16abfa10853..60612b4d371 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RXXGate # RXXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx index 8a0073127c2..bf9fa6c7df1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYGate # RYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx index e415ce1290b..2eb5d10b0fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RYYGate # RYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx index 8c06207bfd2..99803f950bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZGate # RZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx index c386124caa6..1aa2c6dd417 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZXGate # RZXGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx index f81c92d136e..d6023d55019 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RZZGate # RZZGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx index 62a528449b7..02f2d18240c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx index a96b4cdf5e5..c8f5a159b20 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SGate # SGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx index d84bb7ba54d..81ee5e2a648 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXGate # SXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx index 64a35f4e314..f556abf081d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SXdgGate # SXdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx index 0b441432f9d..f92ad800cab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SdgGate # SdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx index b73b47b17a4..3c2f28c5b14 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx index 5aff995c0b4..be7c74c8e0b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.SwapGate # SwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The SWAP gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx index df718aa62a1..715c8bee6b1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TGate # TGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx index 213c72c5b01..e53fcab4c55 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TdgGate # TdgGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx index 58f3c27c21d..a3f627c4003 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.TwoLocal # TwoLocal - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The two-local circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx index 3dbdbd66a25..b89e7dfeb4c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U1Gate # U1Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx index 74d4a0e53a3..aa9f85d5af6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U2Gate # U2Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx index ad0085c3c01..36099cb09bd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.U3Gate # U3Gate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx index 59163ffc167..70ccc0702db 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCGate # UCGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled gate (also called multiplexed gate). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx index 8530fedf0d8..41cf07c52d6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate # UCPauliRotGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Uniformly controlled Pauli rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx index 91bd69215d4..9749f619b74 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRXGate # UCRXGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-X rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx index 482995e6fc1..5a81ccdeeae 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRYGate # UCRYGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Y rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx index f0ffa7c33a7..e2992f0e4a1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UCRZGate # UCRZGate - + Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") Uniformly controlled Pauli-Z rotations. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx index ae85b96c653..2d69f37898e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UGate # UGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx index 1d017a9b0d2..49677cfb70e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx index 1d094e21faf..97e69e85955 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap # UnitaryOverlap - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx index 28d3977a4d2..c276b12ade2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder # VBERippleCarryAdder - + Bases: `Adder` The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx index 4d78e4603b4..d61e06e910c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder # WeightedAdder - + Bases: `BlueprintCircuit` A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx index 9c609417592..5ebf5dce11d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx index e9e3ce17a6d..9dd989331ee 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XOR # XOR - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx index d41fa55d4c6..ecfe1cbbdca 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate # XXMinusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx index a9d76093e6a..9c64498ed4a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate # XXPlusYYGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX+YY interaction gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx index bc5af458ce5..85c4494c303 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.YGate # YGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx index f82eafff884..16f1ce688bc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap # ZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx index d92409290eb..e4f4b8f03df 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZGate # ZGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx index 26b397982fc..6a4f2a5d0cc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx index fb34064ade3..63e428980a8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.iSwapGate # iSwapGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") iSWAP gate. diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.mdx index 76e1e844d15..a8a11d2f957 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx index e6f7eba7d4a..34f214cfc10 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent the information at a node in the DAGDependency(). @@ -91,7 +91,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.mdx index 98051196c85..e95472047e6 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.mdx index 3bcfbb12494..f7d836024c4 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode # DAGInNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an incoming wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.mdx index dcd5419c292..9db81fb6cc0 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Parent class for DAGOpNode, DAGInNode, and DAGOutNode. @@ -19,7 +19,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.mdx index 34dd5323506..f3893daa61d 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode # DAGOpNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an Instruction at a node in the DAGCircuit. @@ -43,7 +43,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.mdx index 2f1ce8a3a6b..2173bbcd59b 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode # DAGOutNode - + Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") Object to represent an outgoing wire node in the DAGCircuit. @@ -29,7 +29,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx index 8981ea79f3b..84543c0611b 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BaseController # BaseController - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of controller. @@ -45,7 +45,7 @@ python_api_name: qiskit.passmanager.BaseController ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx index 4afeab5c399..8a55d5c2cd2 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.BasePassManager # BasePassManager - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Pass manager base class. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx index 2683df49f76..eb6291d972b 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.ConditionalController # ConditionalController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A flow controller runs the pipeline once if the condition is true, or does nothing if the condition is false. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx index aeb37515c4f..d4deebaaab0 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.DoWhileController # DoWhileController - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") Run the given tasks in a loop until the `do_while` condition on the property set becomes `False`. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx index fb2aa7fb57b..4a1a321a85e 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear # FlowControllerLinear - + Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") A standard flow controller that runs tasks one after the other. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx index d7f91126edc..02d3a2aa744 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.GenericPass # GenericPass - + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class of a single pass manager task. @@ -49,7 +49,7 @@ python_api_name: qiskit.passmanager.GenericPass ### run - + Run optimization task. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx index 985ffa20a20..82171b02d38 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PassManagerState # PassManagerState - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A portable container object that pass manager tasks communicate through generator. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx index e15d3e5c080..ce19abd3eb2 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.PropertySet # PropertySet - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A default dictionary-like object. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx index ad19da6a72e..b818a9f5c47 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus # WorkflowStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Collection of compilation status of workflow, i.e. pass manager run. diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx index ceb8376caee..5ca00bd6325 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimator # BackendEstimator - + Bases: [`BaseEstimatorV1`](qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.base.base_estimator.BaseEstimatorV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Evaluates expectation value using Pauli rotation gates. diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx index 470e422e3ac..df48f7a7488 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendEstimatorV2 # BackendEstimatorV2 - + Bases: [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") Evaluates expectation values for provided quantum circuit and observable combinations diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx index 9d2b6772304..9c5bf541423 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSampler # BackendSampler - + Bases: [`BaseSamplerV1`](qiskit.primitives.BaseSamplerV1 "qiskit.primitives.base.base_sampler.BaseSamplerV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] A `BaseSampler` implementation that provides an interface for leveraging the sampler interface from any backend. diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx index 818cd128ba6..30ea92a6d77 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BackendSamplerV2 # BackendSamplerV2 - + Bases: [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.base.base_sampler.BaseSamplerV2") Evaluates bitstrings for provided quantum circuits diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx index 48d8c5690ff..a60feccf566 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV1 # BaseEstimatorV1 - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Estimator V1 base class. diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx index 32008863dde..bcaa16b5fa6 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 # BaseEstimatorV2 - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Estimator V2 base class. @@ -21,7 +21,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 ### run - + Estimate expectation values for each provided pub (Primitive Unified Bloc). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx b/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx index b52a52c44e1..812f9d80f40 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob # BasePrimitiveJob - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)"), [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`ResultT`, `StatusT`] Primitive job abstract base class. @@ -24,13 +24,13 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### cancel - + Attempt to cancel the job. ### cancelled - + Return whether the job has been cancelled. **Return type** @@ -40,7 +40,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### done - + Return whether the job has successfully run. **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### in\_final\_state - + Return whether the job is in a final job state such as `DONE` or `ERROR`. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### result - + Return the results of the job. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### running - + Return whether the job is actively running. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### status - + Return the status of the job. **Return type** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx index ef607fa0938..d73a68a321f 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 # BaseSamplerV1 - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] Sampler V1 base class diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx index 4f188b45f14..c43b8ed6502 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 # BaseSamplerV2 - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Sampler V2 base class. @@ -21,7 +21,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 ### run - + Run and collect samples from each pub. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx b/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx index 8c07ee088db..c9a4a42e6d4 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BitArray # BitArray - + Bases: `ShapedMixin` Stores an array of bit values. @@ -79,7 +79,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate - + Join a sequence of bit arrays along an existing axis. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate\_bits - + Join a sequence of bit arrays along the bits axis. @@ -133,7 +133,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate\_shots - + Join a sequence of bit arrays along the shots axis. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.primitives.BitArray ### from\_bool\_array - + Construct a new bit array from an array of bools. **Parameters** @@ -207,7 +207,7 @@ python_api_name: qiskit.primitives.BitArray ### from\_counts - + Construct a new bit array from one or more `Counts`-like objects. The `counts` can have keys that are (uniformly) integers, hexstrings, or bitstrings. Their values represent numbers of occurrences of that value. @@ -233,7 +233,7 @@ python_api_name: qiskit.primitives.BitArray ### from\_samples - + Construct a new bit array from an iterable of bitstrings, hexstrings, or integers. All samples are assumed to be integers if the first one is. Strings are all assumed to be bitstrings whenever the first string doesn’t start with `"0x"`. diff --git a/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx b/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx index 25ba9e9cc05..50f10daa576 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.DataBin # DataBin - + Bases: `ShapedMixin` Namespace for storing data. diff --git a/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx index 63b3d8e503e..4a06e98ff0e 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Estimator # Estimator - + Bases: [`BaseEstimatorV1`](qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.base.base_estimator.BaseEstimatorV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). diff --git a/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.mdx index 3ffbe2d711e..4a6e696a2a7 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.EstimatorResult # EstimatorResult - + Bases: `_BasePrimitiveResult` Result of Estimator. diff --git a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveJob.mdx b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveJob.mdx index f4288f84521..dba5c71d0f3 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveJob.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.PrimitiveJob # PrimitiveJob - + Bases: [`BasePrimitiveJob`](qiskit.primitives.BasePrimitiveJob "qiskit.primitives.base.base_primitive_job.BasePrimitiveJob")\[`ResultT`, [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.jobstatus.JobStatus")] Primitive job class for the reference implementations of Primitives. diff --git a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.mdx b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.mdx index 0844717f64d..218a94459fe 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.PrimitiveResult # PrimitiveResult - + Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] A container for multiple pub results and global metadata. diff --git a/docs/api/qiskit/dev/qiskit.primitives.PubResult.mdx b/docs/api/qiskit/dev/qiskit.primitives.PubResult.mdx index fc83ff7c8c2..095d367f8c8 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PubResult.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.PubResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.PubResult # PubResult - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Result of Primitive Unified Bloc. diff --git a/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx index 3a308eb29bb..2309b5effd8 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.Sampler # Sampler - + Bases: [`BaseSamplerV1`](qiskit.primitives.BaseSamplerV1 "qiskit.primitives.base.base_sampler.BaseSamplerV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] Sampler class. diff --git a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx index 1fdbb40df17..8700c64edab 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.SamplerResult # SamplerResult - + Bases: `_BasePrimitiveResult` Result of Sampler. diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx index 2bf5795f1a1..a083ebd0501 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.StatevectorEstimator # StatevectorEstimator - + Bases: [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") Simple implementation of [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") with full state vector simulation. diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx index ad16fefd3f2..e8172e0fb84 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.StatevectorSampler # StatevectorSampler - + Bases: [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.base.base_sampler.BaseSamplerV2") Simple implementation of [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") using full state vector simulation. diff --git a/docs/api/qiskit/dev/qiskit.providers.Backend.mdx b/docs/api/qiskit/dev/qiskit.providers.Backend.mdx index 61aa7dd9a3d..bddc364206d 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.Backend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Backend # Backend - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV1.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV1.mdx index 9278c29891c..c693aa23d41 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV1 # BackendV1 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -21,7 +21,7 @@ python_api_name: qiskit.providers.BackendV1 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -51,7 +51,7 @@ python_api_name: qiskit.providers.BackendV1 In addition to the public abstract methods, subclasses should also implement the following private methods: - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -141,7 +141,7 @@ python_api_name: qiskit.providers.BackendV1 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx index 60aa15fd318..487186702e4 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract class for Backends @@ -25,7 +25,7 @@ python_api_name: qiskit.providers.BackendV2 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -324,7 +324,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx index e5c0f43f342..72abbdb8372 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.BackendV2Converter # BackendV2Converter - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") 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. diff --git a/docs/api/qiskit/dev/qiskit.providers.Job.mdx b/docs/api/qiskit/dev/qiskit.providers.Job.mdx index 018e87b52c3..f1c1b04ffcf 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.Job.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Job # Job - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx index e43afb4baee..31bbdeef588 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") Class for job status enumerated type. diff --git a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx index 8a54c427992..86b5640f885 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Class to handle jobs @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.JobV1 ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/dev/qiskit.providers.Options.mdx b/docs/api/qiskit/dev/qiskit.providers.Options.mdx index b35f6c0aa77..7ada83881ff 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Options # Options - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") Base options object diff --git a/docs/api/qiskit/dev/qiskit.providers.Provider.mdx b/docs/api/qiskit/dev/qiskit.providers.Provider.mdx index e34cb3034f8..56d5637adb0 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Provider.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.Provider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.Provider # Provider - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/dev/qiskit.providers.ProviderV1.mdx b/docs/api/qiskit/dev/qiskit.providers.ProviderV1.mdx index a63267b9132..d88e38379c9 100644 --- a/docs/api/qiskit/dev/qiskit.providers.ProviderV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.ProviderV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.ProviderV1 # ProviderV1 - + Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base class for a Backend Provider. @@ -27,7 +27,7 @@ python_api_name: qiskit.providers.ProviderV1 ### backends - + Return a list of backends matching the specified filtering. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/dev/qiskit.providers.QubitProperties.mdx index 5052ace905d..5900557b324 100644 --- a/docs/api/qiskit/dev/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.QubitProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a qubit on a backend. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx index 2e7af4b8ab3..2f2297cf923 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider # BasicProvider - + Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") Provider for test simulators. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx index b7c4008074f..eb2a3d19d40 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError # qiskit.providers.basic\_provider.BasicProviderError - + Base class for errors raised by the Basic Provider. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx index b655c668824..ce5c5f20186 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob # BasicProviderJob - + Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") BasicProviderJob class. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx index 08f0dfb7b7c..51459aa009b 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator # BasicSimulator - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Python implementation of a basic (non-efficient) quantum simulator. diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.mdx index 67ebf6972f4..e4d530eb9ed 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake127QPulseV1 # Fake127QPulseV1 - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake **pulse** backend with the following characteristics: diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.mdx index 692e3d35341..07f87d72b47 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q # Fake1Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 1Q backend. diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.mdx index f7fc3a56fd8..0498c840237 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake20QV1 # Fake20QV1 - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake backend with the following characteristics: diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.mdx index 31a07b6c238..f898402fe21 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake27QPulseV1 # Fake27QPulseV1 - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake **pulse** backend with the following characteristics: diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.mdx index 63360eab407..58d484bcee6 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake5QV1 # Fake5QV1 - + Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") A fake backend with the following characteristics: diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.mdx index b6ab7c8c94f..2aa3bde2598 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.Fake7QPulseV1 # Fake7QPulseV1 - + Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") A fake **pulse** backend with the following characteristics: diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx index 774bc8f7d6b..80b0f4bb9ff 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q # FakeOpenPulse2Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") A fake 2 qubit backend for pulse test. diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx index 85e00512633..4b6affb474b 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q # FakeOpenPulse3Q - + Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") Trivial extension of the FakeOpenPulse2Q. diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx index 73a41989798..c7d63349723 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 # GenericBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Generic [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") implementation with a configurable constructor. This class will return a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") instance that runs on a local simulator (in the spirit of fake backends) and contains all the necessary information to test backend-interfacing components, such as the transpiler. A [`GenericBackendV2`](#qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") instance can be constructed from as little as a specified `num_qubits`, but users can additionally configure the basis gates, coupling map, ability to run dynamic circuits (control flow instructions), instruction calibrations and dtm. The remainder of the backend properties are generated by randomly sampling from default ranges extracted from historical IBM backend data. The seed for this random generation can be fixed to ensure the reproducibility of the backend output. This backend only supports gates in the standard library, if you need a more flexible backend, there is always the option to directly instantiate a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object to use for transpilation. diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.mdx b/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.mdx index 9a0f9679ac8..717b7b82657 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration # BackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Backwards compat shim representing an abstract backend configuration. @@ -99,7 +99,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.mdx b/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.mdx index f5f34541409..b9ee1f348cc 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendProperties # BackendProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing backend properties @@ -61,7 +61,7 @@ python_api_name: qiskit.providers.models.BackendProperties ### from\_dict - + Create a new BackendProperties object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.mdx b/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.mdx index 412dfeb9776..253da30bb9d 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.BackendStatus # BackendStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing Backend Status. @@ -31,7 +31,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### from\_dict - + Create a new BackendStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.Command.mdx b/docs/api/qiskit/dev/qiskit.providers.models.Command.mdx index 727adbccf9f..0fc6654e34b 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.Command.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.Command.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Command # Command - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Command. @@ -32,7 +32,7 @@ python_api_name: qiskit.providers.models.Command ### from\_dict - + Create a new Command object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.mdx b/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.mdx index 5e009a35eda..a973aaaa4dd 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateConfig # GateConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a Gate Configuration @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.GateConfig ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.mdx b/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.mdx index fddc5702810..66b83b0e256 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.GateProperties # GateProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a gate’s properties @@ -44,7 +44,7 @@ python_api_name: qiskit.providers.models.GateProperties ### from\_dict - + Create a new Gate object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.mdx b/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.mdx index dbfbec0e26a..67ae07361ac 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.JobStatus # JobStatus - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for JobStatus. @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.models.JobStatus ### from\_dict - + Create a new JobStatus object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.Nduv.mdx b/docs/api/qiskit/dev/qiskit.providers.models.Nduv.mdx index 6e08a8a9933..5f1284ddd5e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.Nduv.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.Nduv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.Nduv # Nduv - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing name-date-unit-value @@ -50,7 +50,7 @@ python_api_name: qiskit.providers.models.Nduv ### from\_dict - + Create a new Nduv object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx index 9f41a23f295..3514a5123b9 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration # PulseBackendConfiguration - + Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -177,7 +177,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx index 15a7ee15d42..deb6583c28a 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.PulseDefaults # PulseDefaults - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -33,7 +33,7 @@ python_api_name: qiskit.providers.models.PulseDefaults ### from\_dict - + Create a new PulseDefaults object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.mdx b/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.mdx index aff4b183837..09c8ba803c5 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration # QasmBackendConfiguration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing an OpenQASM 2.0 Backend Configuration. @@ -165,7 +165,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration ### from\_dict - + Create a new GateConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.mdx b/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.mdx index eeeb0e24c16..58878f8dd01 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.models.UchannelLO # UchannelLO - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class representing a U Channel LO @@ -40,7 +40,7 @@ python_api_name: qiskit.providers.models.UchannelLO ### from\_dict - + Create a new UchannelLO object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx index 682670074d3..319e1a14886 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap # InstructionScheduleMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") 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: diff --git a/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx index a3c5d3b1d95..02d17e02e1f 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -342,7 +342,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx index 0679f69ac10..7c49a019272 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Time-ordered sequence of instructions with alignment context. @@ -453,7 +453,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.mdx index 522c27c4c8b..33c769b3d1a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel # AcquireChannel - + Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.mdx index b6ea9f08f8e..0e8efd40652 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel # ControlChannel - + Bases: `PulseChannel` Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.mdx index 266a249972c..5eeb1c3a0eb 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel # DriveChannel - + Bases: `PulseChannel` Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.mdx index 8deb59068da..99b70286bf5 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel # MeasureChannel - + Bases: `PulseChannel` Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.mdx index 59b9dbcc61b..e4a2d09f114 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot # MemorySlot - + Bases: `ClassicalIOChannel` Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.mdx index 5714e46150b..30d635765ef 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot # RegisterSlot - + Bases: `ClassicalIOChannel` Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.mdx b/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.mdx index 9d358a5733c..52c45ad58d1 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel # SnapshotChannel - + Bases: `ClassicalIOChannel` Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.mdx index 3fd9f907eb8..4b640969665 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Acquire # Acquire - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.mdx index 9b82ca467a3..9fe9b1a875c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Delay # Delay - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.mdx index 50dc7c012da..5f8f8d98bab 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Play # Play - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.mdx index fb5daab7b6d..db82289d1b2 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Reference # Reference - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Pulse compiler directive that refers to a subroutine. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.mdx index f9a6fa4e009..a8e0c6eba8f 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier # RelativeBarrier - + Bases: `Directive` Pulse `RelativeBarrier` directive. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.mdx index 112b5c2d973..1ca693de4d5 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency # SetFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.mdx index 3255797db93..937ea6b4d2c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase # SetPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.mdx index 91f6e4f5f67..59a514c0b13 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency # ShiftFrequency - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.mdx index 16a07baf5b3..62a0d329f52 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase # ShiftPhase - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.mdx index 01ee348eef0..fe3ed365d3b 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot # Snapshot - + Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx index 9b01884d12d..750dd175e62 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.mdx index 1f6d824e0d5..fdbf208985e 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Constant # Constant - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.mdx index c5b1a8bc897..a99ae0f1e12 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Drag # Drag - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.mdx index ed651dbf0ce..6ca61d1c16b 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare # GaussianSquare - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.mdx index dba0618e241..4469f97e6e1 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Gaussian # Gaussian - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx index a171c203c5e..af8763a056c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.mdx index f90859213b3..5dabdbcd5ba 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.Waveform # Waveform - + Bases: `Pulse` A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.mdx index ac12c9147d3..a4e429fd9fb 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced # AlignEquispaced - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions with equispaced interval within a specified duration. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx index e307499f9a6..a86309f6e18 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.mdx index e9855962148..a035bdc1f7f 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft # AlignLeft - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-soon-as-possible manner. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.mdx index bd2fd495d2d..c056ce6c1c3 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight # AlignRight - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions in as-late-as-possible manner. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.mdx index 389bb03bfc4..41195cff3d3 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential # AlignSequential - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Align instructions sequentially. diff --git a/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.mdx b/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.mdx index dbfab457c63..32b9447e059 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.GateCalibration # GateCalibration - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. @@ -26,7 +26,7 @@ python_api_name: qiskit.qobj.GateCalibration ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.mdx index 2030e462564..f9cce4c462f 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem # PulseLibraryItem - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An item in a pulse library. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem ### from\_dict - + Create a new PulseLibraryItem object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.mdx index daed94e2b6a..30712228043 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobj # PulseQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.PulseQobj ### from\_dict - + Create a new PulseQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.mdx index 4c771684cb4..a27663f5d8d 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig # PulseQobjConfig - + Bases: `QobjDictField` A configuration for a Pulse Qobj. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig ### from\_dict - + Create a new PulseQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.mdx index 125d4cd1fd0..d93cece75a3 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment # PulseQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A Pulse Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment ### from\_dict - + Create a new PulseQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.mdx index 8f0adec0d57..b8bf493077f 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig # PulseQobjExperimentConfig - + Bases: `QobjDictField` A config for a single Pulse experiment in the qobj. @@ -25,7 +25,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.mdx b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.mdx index 848747eda74..dc380509210 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction # PulseQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an PulseQobj Experiment. @@ -39,7 +39,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction ### from\_dict - + Create a new PulseQobjExperimentConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.mdx index fd251f735a4..9efe1f5ef33 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations # QasmExperimentCalibrations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations ### from\_dict - + Create a new GateCalibration object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.mdx index 456f4458d10..1a36333c9aa 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobj # QasmQobj - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj. @@ -28,7 +28,7 @@ python_api_name: qiskit.qobj.QasmQobj ### from\_dict - + Create a new QASMQobj object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.mdx index cb9887e514d..3c924b5937b 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig # QasmQobjConfig - + Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") A configuration for an OpenQASM 2 Qobj. @@ -36,7 +36,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig ### from\_dict - + Create a new QasmQobjConfig object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.mdx index 6b3eb1ba84a..a658dcd9605 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment # QasmQobjExperiment - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An OpenQASM 2 Qobj Experiment. @@ -27,7 +27,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment ### from\_dict - + Create a new QasmQobjExperiment object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.mdx index ef2628fea23..616ab336a34 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig # QasmQobjExperimentConfig - + Bases: `QobjDictField` Configuration for a single OpenQASM 2 experiment in the qobj. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.mdx b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.mdx index d06be6e0146..719a5a25bbf 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction # QasmQobjInstruction - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a single instruction in an QasmQobj Experiment. @@ -34,7 +34,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction ### from\_dict - + Create a new QasmQobjInstruction object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.mdx b/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.mdx index 599c1d4e685..34ecd298cd0 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader # QobjExperimentHeader - + Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") A class representing a header dictionary for a Qobj Experiment. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.mdx b/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.mdx index 0c7d9b52693..7e50b6a3349 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjHeader # QobjHeader - + Bases: `QobjDictField` A class used to represent a dictionary header in Qobj objects. @@ -23,7 +23,7 @@ python_api_name: qiskit.qobj.QobjHeader ### from\_dict - + Create a new QobjHeader object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.mdx b/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.mdx index 2d35efd96f7..7b0042a8e79 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.mdx +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption # QobjMeasurementOption - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") An individual measurement option. @@ -24,7 +24,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption ### from\_dict - + Create a new QobjMeasurementOption object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx index 4f6487c4874..0dba9e8839d 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx index 253851c66cb..40ca803efd9 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx index 21c2b08d352..fab577f2737 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx index 6658400ca23..d02897a095d 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -273,7 +273,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -295,13 +295,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -349,7 +349,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_linear\_function - + Create a Clifford from a Linear Function. If the linear function is represented by a nxn binary invertible matrix A, then the corresponding Clifford has symplectic matrix \[\[A^t, 0], \[0, A^\{-1}]]. @@ -369,7 +369,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -393,7 +393,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -417,7 +417,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_permutation - + Create a Clifford from a PermutationGate. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx index 1abe197c014..2f769b670d8 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -184,7 +184,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -208,7 +208,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx index c57952f87af..66fbe034291 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Kraus # Kraus - + Bases: `QuantumChannel` Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx index 51d99766495..aed6aa86f43 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -254,7 +254,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -279,7 +279,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx index e613a1dedce..b8b14aa9a2f 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx index 5f06ff8f702..bb5db52c9e7 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -473,7 +473,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx index d0eb3f0c9bd..a6e6abdf13d 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -424,7 +424,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.mdx index ac72d76e95f..baf0c2ae491 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class representing a Quaternion. @@ -17,7 +17,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_axis\_rotation - + Return quaternion for rotation about given axis. **Parameters** @@ -40,7 +40,7 @@ python_api_name: qiskit.quantum_info.Quaternion ### from\_euler - + Generate a quaternion from a set of Euler angles. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx index d61dc1e72aa..0b245c45094 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.ScalarOp # ScalarOp - + Bases: `LinearOp` Scalar identity operator class. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx index 2d79396db51..56bc91fa22e 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -365,7 +365,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -403,7 +403,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential in general because the number of possible Pauli terms in the decomposition is exponential in the number of qubits. @@ -431,7 +431,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -734,7 +734,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx index 2269732b46f..417202eba8e 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). @@ -188,7 +188,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### from\_stabilizer\_list - + Create a stabilizer state from the collection of stabilizers. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx index 40898f409f5..13ad4cdfaec 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx index e2f1088f56b..d93651f1073 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx index 17e3bcf3367..1b8ff9550ee 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx index 0437a8cb5f6..e79a45a4cd7 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -111,7 +111,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries ### find\_z2\_symmetries - + Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). **Returns** diff --git a/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.mdx b/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.mdx index 7c07f4fa6d8..f00677bee60 100644 --- a/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.mdx +++ b/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator # BaseReadoutMitigator - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Base readout error mitigator class. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### expectation\_value - + Calculate the expectation value of a diagonal Hermitian operator. **Parameters** @@ -39,7 +39,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator ### quasi\_probabilities - + Convert counts to a dictionary of quasi-probabilities **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.mdx b/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.mdx index d618f102c19..2f78e29df5e 100644 --- a/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.mdx +++ b/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator # CorrelatedReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") N-qubit readout error mitigator. diff --git a/docs/api/qiskit/dev/qiskit.result.Counts.mdx b/docs/api/qiskit/dev/qiskit.result.Counts.mdx index aa9fed1c50d..75f527cf990 100644 --- a/docs/api/qiskit/dev/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/dev/qiskit.result.Counts.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Counts # Counts - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.mdx b/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.mdx index 829830b9eca..8612ab6a2c0 100644 --- a/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.mdx +++ b/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator # LocalReadoutMitigator - + Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") 1-qubit tensor product readout error mitigator. diff --git a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx index 0cd6768991b..def435e1c47 100644 --- a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx index 98d787b6418..d6549cd0d53 100644 --- a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") A dict-like class for representing quasi-probabilities. diff --git a/docs/api/qiskit/dev/qiskit.result.Result.mdx b/docs/api/qiskit/dev/qiskit.result.Result.mdx index 367ddc4f9d9..7d791f1bb04 100644 --- a/docs/api/qiskit/dev/qiskit.result.Result.mdx +++ b/docs/api/qiskit/dev/qiskit.result.Result.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.result.Result # Result - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Model for Results. @@ -109,7 +109,7 @@ python_api_name: qiskit.result.Result ### from\_dict - + Create a new ExperimentResultData object from a dictionary. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.result.ResultError.mdx b/docs/api/qiskit/dev/qiskit.result.ResultError.mdx index 331e55ead41..edff40fcbb0 100644 --- a/docs/api/qiskit/dev/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/dev/qiskit.result.ResultError.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError - + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx index fa71075cca3..d650507e1ef 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Interface for evolution synthesis algorithms. @@ -33,7 +33,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.mdx index 9e7f16a4ccf..aed4d171297 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.LieTrotter # LieTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The Lie-Trotter product formula. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.mdx index b037cdaa102..61785d90f6b 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.MatrixExponential # MatrixExponential - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Exact operator evolution via matrix exponentiation and unitary synthesis. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.mdx index 75545c67f3a..3bec1535fac 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer # OneQubitEulerDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.mdx index 19f65c97130..c6426af02b5 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.ProductFormula # ProductFormula - + Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") Product formula base class for the decomposition of non-commuting operator exponentials. @@ -43,7 +43,7 @@ python_api_name: qiskit.synthesis.ProductFormula ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/dev/qiskit.synthesis.QDrift.mdx index ca6e7f17cfc..965bc02d35d 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.QDrift.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.QDrift # QDrift - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in Ref. \[1]. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx index 34875378f6c..6d8cae9778a 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Solovay Kitaev discrete decomposition algorithm. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.mdx index f86353ceb8c..d72b141ff7c 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter # SuzukiTrotter - + Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") The (higher order) Suzuki-Trotter product formula. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.mdx index 968a002be19..a43a290173b 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -50,7 +50,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer ### decomp0 - + Decompose target $\sim U_d(x, y, z)$ with $0$ uses of the basis gate. Result $U_r$ has trace: $$ diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx index 11f292acf57..b7a76e0d36b 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.TwoQubitWeylDecomposition # TwoQubitWeylDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Two-qubit Weyl decomposition. @@ -110,7 +110,7 @@ $$ ### from\_bytes - + Decode bytes into [`TwoQubitWeylDecomposition`](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). **Return type** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx index 59437bb408d..86a352a60b3 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.XXDecomposer # XXDecomposer - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of `XX` type (i.e., each locally equivalent to $CAN(\alpha, 0, 0)$ for a possibly varying $alpha$). diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx index 099e7b52b09..552307e10c9 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC # AQC - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A generic implementation of the Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 8529b706d5e..7eb71bba9ff 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit # ApproximateCircuit - + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class that represents an approximate circuit. @@ -236,7 +236,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit ### build - + **Constructs this circuit out of the parameters(thetas). Parameter values must be set before** constructing the circuit. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx index 9395f24fb86..5dc0fb0c764 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective # ApproximatingObjective - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -31,7 +31,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index 2569d5e8a3d..bca25f48d93 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit # CNOTUnitCircuit - + Bases: [`ApproximateCircuit`](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.approximate.ApproximateCircuit") A class that represents an approximate circuit based on CNOT unit blocks. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx index bcf00cb8be1..34c2e1b7d15 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective # CNOTUnitObjective - + Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx index 4088c69808a..d348762b6f1 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective # DefaultCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") A naive implementation of the objective function based on CNOT units. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index 2b58d459fce..4df9e2acf1f 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective # FastCNOTUnitObjective - + Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx index 75ea11d33f2..d8124491968 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.AnalysisPass # AnalysisPass - + Bases: `BasePass` An analysis pass: change property set, not DAG. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.mdx index e79d8396bf5..fa6581e7449 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Directed graph specifying fixed coupling. @@ -181,7 +181,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_full - + Return a fully connected coupling map on n qubits. **Return type** @@ -191,7 +191,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_grid - + Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. **Return type** @@ -201,7 +201,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_hex - + Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: @@ -224,7 +224,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_heavy\_square - + Return a heavy square graph coupling map. A heavy square graph is described in: @@ -247,7 +247,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_hexagonal\_lattice - + Return a hexagonal lattice graph coupling map. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_line - + Return a coupling map of n qubits connected in a line. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.transpiler.CouplingMap ### from\_ring - + Return a coupling map of n qubits connected to each of their neighbors in a ring. **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx index 6e62f79f207..577c3e2aa23 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Helper class to provide durations of instructions for scheduling. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.InstructionDurations ### from\_backend - + Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.mdx b/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.mdx index b102ab64bd1..5982dfecf08 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.InstructionProperties # InstructionProperties - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A representation of the properties of a gate implementation. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx index f8b024fbc99..af6f13b0545 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Two-ways dict to represent a Layout. @@ -134,7 +134,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_intlist - + Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.transpiler.Layout ### from\_qubit\_list - + Populates a Layout from a list containing virtual qubits, Qubit or None. **Parameters** @@ -180,7 +180,7 @@ python_api_name: qiskit.transpiler.Layout ### generate\_trivial\_layout - + Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. **Parameters** @@ -233,7 +233,7 @@ python_api_name: qiskit.transpiler.Layout ### order\_based\_on\_type - + decides which one is physical/virtual based on the type. Returns (virtual, physical) diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx index 1b89dc1c541..e4936fc75f8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManager # PassManager - + Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.mdx index 8a32473f6bc..c2340dadb5d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Pass Manager Configuration. @@ -40,7 +40,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig ### from\_backend - + Construct a configuration based on a backend and user input. This method automatically gererates a PassManagerConfig object based on the backend’s features. User options can be used to overwrite the configuration. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx index ed376509b4f..82442a76ff1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.StagedPassManager # StagedPassManager - + Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") A pass manager pipeline built from individual stages. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx b/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx index 116a4171675..119547304c0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") 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. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -242,7 +242,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx index adbbfa1679b..bde1bad1fe3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TransformationPass # TransformationPass - + Bases: `BasePass` A transformation pass: change DAG, not property set. @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx index 868ef148cce..be096e4fe3a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Layout attributes for the output circuit from transpiler. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.mdx index b5498c4f776..b9ab449c24f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule # ALAPSchedule - + Bases: `BaseSchedulerTransform` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 5de46249e0b..9e66c4bab82 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis # ALAPScheduleAnalysis - + Bases: `BaseScheduler` ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.mdx index 24c097e9d6c..cc29aa14081 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule # ASAPSchedule - + Bases: `BaseSchedulerTransform` ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index c3b0b180819..e1c5fc97db3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis # ASAPScheduleAnalysis - + Bases: `BaseScheduler` ASAP Scheduling pass, which schedules the start time of instructions as early as possible. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.mdx index 252d45a9e3f..b57d1ceccae 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures # AlignMeasures - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Measurement alignment. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx index 672817470d9..cbe3631b35e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout # ApplyLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index b8eff69f1c7..0df1aa7c530 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx index b6eedd0f38c..f273d163f87 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap # BasicSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map (with minimum effort) a DAGCircuit onto a `coupling_map` adding swap gates. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx index 2f90432ebf3..3b0ec92cc11 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx index 74557bea415..48efc27f5cb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout # CSPLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.mdx index 9ef1567735d..62932d98a6c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation # CXCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel back-to-back `cx` gates in dag. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx index f0830c55d18..d9a376a7c79 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection # CheckGateDirection - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx index c085638fb13..66529134aa5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap # CheckMap - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx index 2f309cafaa7..1389a25035e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns # Collect1qRuns - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect one-qubit subcircuits. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx index 3bea6670a73..f366f7fc813 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks # Collect2qBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect two-qubit subcircuits. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx index 5bbd9f09164..fdf5d92cae2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx index c79a659c46e..7113f8eb806 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions # CollectLinearFunctions - + Bases: `CollectAndCollapse` Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index d36aac2940a..b9fe3ce77e5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks # CollectMultiQBlocks - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Collect sequences of uninterrupted gates acting on groups of qubits. `max_block_size` specifies the maximum number of qubits that can be acted upon by any single group of gates diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx index 9778dd86056..078a686b2d8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis # CommutationAnalysis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx index 3e26f509ea5..1065f594b98 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation # CommutativeCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index ef56321cfca..cc9ba5f4a2c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation # CommutativeInverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel pairs of inverse gates exploiting commutation relations. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 8cb12073e7b..495e34e51d8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx index e6ce88b968e..94a24d4962c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx index bd609dced2f..e8e99668034 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule # ConstrainedReschedule - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Rescheduler pass that updates node start times to conform to the hardware alignments. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx index 0c20bae64a9..1e46c307a49 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction # ContainsInstruction - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") An analysis pass to detect if the DAG contains a specific instruction. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx index abef22d21dc..ce803712df1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps # ConvertConditionsToIfOps - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx index 3ad66b65f59..dc308c940b7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOps # CountOps - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx index bd9bdcc21c8..e917c95d5ce 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath # CountOpsLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Count the operations on the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx index 6d4b8c23191..60b6b9aee6c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint # DAGFixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx index d662409db8e..b51eb0caa25 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath # DAGLongestPath - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Return the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") as a list of [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")s, [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")s, and [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")s. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx index 45d4f14b207..82d3eba005e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Decompose # Decompose - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx index fbe1ebc645d..e5d4e4c23da 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout # DenseLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx index ce6bffa5bf3..23bbaad8454 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Depth # Depth - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.mdx index 1a6e2377960..5072b58f60c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling # DynamicalDecoupling - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx index d789a4c67c4..63056d2f34f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition # EchoRZXWeylDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Rewrite two-qubit gates using the Weyl decomposition. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx index 3b53b035231..45aa434fe38 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations # ElidePermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove permutation operations from a pre-layout circuit diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index 939ba45bf35..efdb8d8a926 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla # EnlargeWithAncilla - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx index b88794ce84a..6ba140eb0a3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes # FilterOpNodes - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove all operations that match a filter function diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx index c542b9b1fd3..9a27d56ee72 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint # FixedPoint - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx index e6ea3e91e2f..5000ddbba61 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation # FullAncillaAllocation - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Allocate all idle nodes from the coupling map or target as ancilla on the layout. @@ -122,7 +122,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation ### validate\_layout - + Checks if all the qregs in `layout_qregs` already exist in `dag_qregs`. Otherwise, raise. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx index 90ccd9dd52c..a7b0bcdb3f4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection # GateDirection - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx index 91679d51a34..3d3ddc236fa 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.mdx index 1a2649c061b..14b20c1332a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig # HLSConfig - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The high-level-synthesis config allows to specify a list of “methods” used by [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transformation pass to synthesize different types of higher-level objects. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx index caaf4d2e9d7..db37fdcfaff 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis # HighLevelSynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize higher-level objects and unroll custom definitions. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx index df1dbe43d53..85ab18ddb4b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer # HoareOptimizer - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This is a transpiler pass using Hoare logic circuit optimization. The inner workings of this are detailed in: [https://arxiv.org/abs/1810.00375](https://arxiv.org/abs/1810.00375) diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx index bac79bf4969..865aabf7b0c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck # InstructionDurationCheck - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Duration validation pass for reschedule. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx index db3abdb7dc5..a1505b85725 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation # InverseCancellation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Cancel specific Gates which are inverses of each other when they occur back-to- back. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx index 6dd2caad45f..d528dd9cac6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance # Layout2qDistance - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 24d572022f1..42b37e4d95e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations # LinearFunctionsToPermutations - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Promotes linear functions to permutations when possible. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx index 3c101b8dd87..3f2f4f5a221 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap # LookaheadSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 219ba821033..75fc34a4972 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx index 69707cb480f..4395180c294 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint # MinimumPoint - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Check if the DAG has reached a relative semi-stable point over previous runs diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.mdx index a1f0dc198e3..610f5319cba 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle # NormalizeRXAngle - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Normalize theta parameter of RXGate instruction. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx index 2940ccf098e..16ae65b8d28 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors # NumTensorFactors - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx index 9e7976ffc93..1454fbf415b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates # Optimize1qGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -43,7 +43,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### compose\_u3 - + Return a triple theta, phi, lambda for the product. **u3(theta, phi, lambda)** @@ -126,7 +126,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates ### yzy\_to\_zyz - + Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. Solve the equation diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 07568b1ef66..ed2c6a521ef 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition # Optimize1qGatesDecomposition - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 7e517622763..cb8869c8774 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation # Optimize1qGatesSimpleCommutation - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and resynthesizing the results. The commutation rules are stored in `commutation_table`. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx index c597d7d15f8..5a15177682a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated # OptimizeAnnotated - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimization pass on circuits with annotated operations. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx index 712eed6acf8..aa78eedd830 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords # OptimizeCliffords - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Combine consecutive Cliffords over the same qubits. This serves as an example of extra capabilities enabled by storing Cliffords natively on the circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx index 73a80e439b3..587089d3bbe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 25f44ff59fb..66b20dc2e42 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling # PadDynamicalDecoupling - + Bases: `BasePadding` Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.mdx index c4445e84faa..f3cceeab4f4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates # PulseGates - + Bases: `CalibrationBuilder` Pulse gate adding pass. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx index 48cbc7ebd34..30d092d3e5b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder # RXCalibrationBuilder - + Bases: `CalibrationBuilder` Add single-pulse RX calibrations that are bootstrapped from the SX calibration. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx index 49d43e27b84..62cc2809cb0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder # RZXCalibrationBuilder - + Bases: `CalibrationBuilder` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx index 93d0508f800..9877ba1f2c4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho # RZXCalibrationBuilderNoEcho - + Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho ### rescale\_cr\_inst - + A builder macro to play stretched pulse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx index 736061681b1..dad004772fc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers # RemoveBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index bc361ad914f..ac4e53c4536 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure # RemoveDiagonalGatesBeforeMeasure - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 0db7919ec1c..97a92b1c1fd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements # RemoveFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx index 62cc0b23051..1826b6f09dc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset # RemoveFinalReset - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset when it is the final instruction on a qubit wire. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 138e257fddb..bc1efd68c87 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState # RemoveResetInZeroState - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index 9d303195485..9e4a67f0f59 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification # ResetAfterMeasureSimplification - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx index 4f003f0af01..4ca5770c9f4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout # SabreLayout - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx index 2b5a2bb9202..01e69504fad 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout # SabrePreLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a starting layout to use for additional Sabre layout trials. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx index 34864b89cc1..834a5f984bb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap # SabreSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx index 7d547597a83..b4c5096f538 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency # SetIOLatency - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx index 5b7e8551d90..f71be5a2e41 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout # SetLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx index e7115a39c11..aded199863e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Size # Size - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx index d6fc3d18889..f8abed0e116 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx index fbd1ddbfd8a..f4b98b6cf54 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting # StarPreRouting - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Run star to linear pre-routing diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.mdx index c0a65fe5394..82b1b645dc0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap # StochasticSwap - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx index e7d4473e89a..ff84ea2f4f3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization # TemplateOptimization - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Class for the template optimization pass. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx index 642968cd580..0e9d282c227 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion # TimeUnitConversion - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 9cefc2c4f4b..75c54e95fcb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates # TranslateParameterizedGates - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translate parameterized gates to a supported basis set. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx index cd69f152cfb..d9693942173 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout # TrivialLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx index 7cd03eacad8..e344ea9e3ed 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx index b32f9ad379b..e07f6ddf70c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore # Unroll3qOrMore - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 8806669562a..b05d842181c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions # UnrollCustomDefinitions - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx index 128ba93a901..fed1849a940 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops # UnrollForLoops - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx index 65cf086f9b9..e43a5257d7a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout # VF2Layout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for choosing a Layout of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx index 3480f6d855f..a5482043e15 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout # VF2PostLayout - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") A pass for improving an existing Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.mdx index 3da7459c159..f52be5fb92b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates # ValidatePulseGates - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check custom gate length. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx index cde11e90388..25e2c19a066 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Width # Width - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.mdx index 801d9c9b48d..184f9564360 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugi # AQCSynthesisPlugin - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") An AQC-based Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.mdx index 8d7c4f09c0a..36be49933e7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynt # ACGSynthesisPermutation - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.mdx index 1c1d7845031..1da0a01c7f2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynth # AGSynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Clifford synthesis plugin based on the Aaronson-Gottesman method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.mdx index 2f9469aab7e..7843a1fab61 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynth # BMSynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Clifford synthesis plugin based on the Bravyi-Maslov method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.mdx index 7680921114e..ec41ef751ea 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSy # BasicSynthesisPermutation - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on sorting. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.mdx index a5d4e24fed1..0300fc677d8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.Default # DefaultSynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The default clifford synthesis plugin. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.mdx index 6d01160d3d3..636517c9971 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.Default # DefaultSynthesisLinearFunction - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The default linear function synthesis plugin. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.mdx index 0972b19084c..d7df7bb3586 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedyS # GreedySynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Clifford synthesis plugin based on the greedy synthesis Bravyi-Hu-Maslov-Shaydulin method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.mdx index 046a25a6e4a..e9ec256ccb4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynt # KMSSynthesisLinearFunction - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Linear function synthesis plugin based on the Kutin-Moulton-Smithline method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.mdx index b067e6c0047..336d0608ed0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynt # KMSSynthesisPermutation - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.mdx index 86ce3c49bd1..29cb813a391 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLn # LayerLnnSynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Clifford synthesis plugin based on the Bravyi-Maslov method to synthesize Cliffords into layers, with each layer synthesized adhering to LNN connectivity. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.mdx index ec0f43a95a1..8d785971280 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSy # LayerSynthesisClifford - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Clifford synthesis plugin based on the Bravyi-Maslov method to synthesize Cliffords into layers. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.mdx index cb762e804fd..b8296d28346 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynt # PMHSynthesisLinearFunction - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") Linear function synthesis plugin based on the Patel-Markov-Hayes method. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.mdx index 19d04778400..bd66dde11fd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSw # TokenSwapperSynthesisPermutation - + Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") The permutation synthesis plugin based on the token swapper algorithm. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index 7da472f807a..a4932f2f690 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract high-level synthesis plugin class. @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index 250d1932212..9c24c885455 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index cf41e8d0d11..d574cae3f20 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") Abstract unitary synthesis plugin class @@ -176,7 +176,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 12a7091f680..5d2ecc20e2b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx index e7c82684ce8..d438df741f6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.Sol # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx index a24ba57abf8..b1084da5a62 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni # DefaultUnitarySynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") The default unitary synthesis plugin. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index c6e07737a85..9f809666a39 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 4bdd45f12d0..f1716499f03 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Manager class for preset pass manager stage plugins. diff --git a/docs/api/qiskit/dev/qpy.mdx b/docs/api/qiskit/dev/qpy.mdx index f10c435f19e..8a66fecea68 100644 --- a/docs/api/qiskit/dev/qpy.mdx +++ b/docs/api/qiskit/dev/qpy.mdx @@ -166,7 +166,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski ### QpyError - + Errors raised by the qpy module. Set the error message. @@ -176,7 +176,7 @@ When a lower-than-maximum target QPY version is set for serialization, but the o ### UnsupportedFeatureForVersion - + QPY error raised when the target dump version is too low for a feature that is present in the object to be serialized. **Parameters** @@ -216,7 +216,7 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY ### QPYLoadingDeprecatedFeatureWarning - + Visible deprecation warning for QPY loading functions without a stable point in the call stack. diff --git a/docs/api/qiskit/dev/scheduler.mdx b/docs/api/qiskit/dev/scheduler.mdx index 7e91c9d6086..5e3cf919405 100644 --- a/docs/api/qiskit/dev/scheduler.mdx +++ b/docs/api/qiskit/dev/scheduler.mdx @@ -24,7 +24,7 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig - + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/dev/transpiler.mdx b/docs/api/qiskit/dev/transpiler.mdx index 36fb8bb6714..4124b41fb20 100644 --- a/docs/api/qiskit/dev/transpiler.mdx +++ b/docs/api/qiskit/dev/transpiler.mdx @@ -937,7 +937,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError - + Exceptions raised during transpilation. Set the error message. @@ -945,7 +945,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError - + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -953,7 +953,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError - + Base class for errors raised by the coupling graph object. Set the error message. @@ -961,7 +961,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError - + Errors raised by the layout object. Set the error message. @@ -969,7 +969,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CircuitTooWideForTarget - + Error raised if the circuit is too wide for the target. Set the error message. @@ -977,7 +977,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### InvalidLayoutError - + Error raised when a user provided layout is invalid. Set the error message. diff --git a/docs/api/qiskit/dev/utils.mdx b/docs/api/qiskit/dev/utils.mdx index 2a6c61f52b7..f7f3de13a6e 100644 --- a/docs/api/qiskit/dev/utils.mdx +++ b/docs/api/qiskit/dev/utils.mdx @@ -365,7 +365,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -405,7 +405,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -472,7 +472,7 @@ from qiskit.utils import LazyImportTester #### LazyImportTester - + 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. **Parameters** @@ -486,7 +486,7 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester - + 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. **Parameters** diff --git a/docs/api/qiskit/dev/visualization.mdx b/docs/api/qiskit/dev/visualization.mdx index 0c37fffd4f5..517713277ad 100644 --- a/docs/api/qiskit/dev/visualization.mdx +++ b/docs/api/qiskit/dev/visualization.mdx @@ -225,7 +225,7 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError - + For visualization specific errors. Set the error message.